mirror of
https://github.com/alexhopeoconnor/firmware.git
synced 2026-10-04 11:28:11 +10:00
Compare commits
40
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a1acad6dc4 | ||
|
|
2a91d186eb | ||
|
|
4827498188 | ||
|
|
3a0c08b695 | ||
|
|
7bdff8ff70 | ||
|
|
35b0590408 | ||
|
|
cbddf07bc8 | ||
|
|
871194517d | ||
|
|
5a1d2b9ef4 | ||
|
|
9cd3a86938 | ||
|
|
748668b8e9 | ||
|
|
778d1ad90f | ||
|
|
1ae4a538f5 | ||
|
|
c756bbe2c1 | ||
|
|
4c3ba612bb | ||
|
|
75b7a7df4f | ||
|
|
59025e4820 | ||
|
|
8110887be2 | ||
|
|
5f734dabf9 | ||
|
|
039ad42758 | ||
|
|
593909c26b | ||
|
|
0a7b3c723e | ||
|
|
29a61dc75c | ||
|
|
eead467ce6 | ||
|
|
f3ae02c425 | ||
|
|
d9cb74e4dd | ||
|
|
7ff6641f97 | ||
|
|
cd5d608e8d | ||
|
|
f7548e7c25 | ||
|
|
b960121464 | ||
|
|
b074645586 | ||
|
|
811dd427dd | ||
|
|
7f5184281d | ||
|
|
1c06b702dc | ||
|
|
59b4993861 | ||
|
|
4446b0f1a2 | ||
|
|
64fd61706d | ||
|
|
da61a0db7d | ||
|
|
8e99ffbe7e | ||
|
|
8877608858 |
@@ -8,17 +8,21 @@
|
||||
"features": {
|
||||
"ghcr.io/devcontainers/features/python:1": {
|
||||
"installTools": true,
|
||||
"version": "3.14"
|
||||
"version": "3.13"
|
||||
}
|
||||
},
|
||||
"customizations": {
|
||||
"vscode": {
|
||||
"extensions": [
|
||||
"ms-vscode.cpptools",
|
||||
"platformio.platformio-ide",
|
||||
"Jason2866.esp-decoder",
|
||||
"pioarduino.pioarduino-ide",
|
||||
"Trunk.io"
|
||||
],
|
||||
"unwantedRecommendations": ["ms-azuretools.vscode-docker"],
|
||||
"unwantedRecommendations": [
|
||||
"ms-azuretools.vscode-docker",
|
||||
"platformio.platformio-ide"
|
||||
],
|
||||
"settings": {
|
||||
"extensions.ignoreRecommendations": true
|
||||
}
|
||||
|
||||
@@ -193,22 +193,26 @@ Writers go through `setNodeStatus`, `updatePosition`, `updateTelemetry` (which d
|
||||
|
||||
Every code path that drops a node from the header table must also evict the satellites. The single chokepoint is `eraseNodeSatellites(NodeNum)`; it's already called from `getOrCreateMeshNode`'s oldest-boring eviction, `removeNodeByNum`, both branches of `resetNodes`, `cleanupMeshDB`, `addFromContact`'s ignored-branch, and `AdminModule`'s `set_ignored_node`. Add new eviction sites here, not by calling `.erase()` directly.
|
||||
|
||||
### Gradient sync (opt-in via special nonces)
|
||||
### Sync flow: thin NodeInfo + post-COMPLETE_ID replay (no opt-in)
|
||||
|
||||
`client_capabilities` is **not** a thing in this branch. Phone clients opt into the new sync flow by sending one of two values in the `ToRadio.want_config_id`:
|
||||
There is no capability flag and no special "gradient" nonce. The **default** sync flow is:
|
||||
|
||||
- `SPECIAL_NONCE_GRADIENT_SYNC` (69422) — full config + thin NodeInfo + replay phases.
|
||||
- `SPECIAL_NONCE_GRADIENT_ONLY_NODES` (69423) — skip config segments, NodeInfo + replay only.
|
||||
1. Config / module-config / channel / metadata segments (same as before).
|
||||
2. `STATE_SEND_OWN_NODEINFO` — **our own** NodeInfo, still bundled with our position and device_metrics (because the replay snapshot excludes our own NodeNum). Emitted via `ConvertToNodeInfo(lite)`.
|
||||
3. `STATE_SEND_OTHER_NODEINFOS` — every other peer's NodeInfo, **always thin** (no `position`, no `device_metrics`). Emitted via `ConvertToNodeInfoThin(lite)`.
|
||||
4. `STATE_SEND_FILEMANIFEST` → `STATE_SEND_COMPLETE_ID` — the phone sees `config_complete_id` and treats sync as done.
|
||||
5. `STATE_SEND_PACKETS` — live mesh packets, with a trailing replay drain interleaved. The replay drain walks four cached satellite stores in order (positions → telemetry → environment → status) and emits each cached entry as an ordinary `MeshPacket` on the matching portnum (`POSITION_APP`, `TELEMETRY_APP` device + environment variants, `NODE_STATUS_APP`). These are indistinguishable on the wire from live mesh traffic, so clients need no special handling — any code that already updates UI on `POSITION_APP` etc. works.
|
||||
|
||||
`PhoneAPI::clientWantsGradientSync()` is the single switch. When true, `STATE_SEND_OTHER_NODEINFOS` is followed by:
|
||||
`PhoneAPI::sendConfigComplete()` arms `replayPhase = REPLAY_PHASE_POSITIONS` for default/full sync and `SPECIAL_NONCE_ONLY_NODES`, while `SPECIAL_NONCE_ONLY_CONFIG` skips replay. The drain runs inside `STATE_SEND_PACKETS` via `popReplayPacket()`, lower priority than live traffic. When all four phases drain, `replayPhase` flips back to `REPLAY_PHASE_IDLE` and the snapshot vectors get `shrink_to_fit`ed.
|
||||
|
||||
```text
|
||||
STATE_REPLAY_POSITIONS → STATE_REPLAY_TELEMETRY → STATE_REPLAY_ENVIRONMENT → STATE_REPLAY_STATUS
|
||||
```
|
||||
STM32WL and any other build with all four `MESHTASTIC_EXCLUDE_*DB` flags set produces zero replay packets — `popReplayPacket` advances through each phase in microseconds without emitting anything.
|
||||
|
||||
Each replay phase walks the corresponding satellite map and emits synthetic `MeshPacket`s on the matching portnum (`POSITION_APP`, `TELEMETRY_APP` for both device + environment variants, `STATUS_MESSAGE_APP`). Legacy clients (no special nonce) get the bundled-NodeInfo path with position/device_metrics joined back in by `ConvertToNodeInfo(lite, pos*, dm*)` — wire bytes are byte-identical to pre-v25 for them.
|
||||
Special nonces that still mean something:
|
||||
|
||||
`ConvertToNodeInfoThin(lite)` is the gradient-sync emitter (no position/telemetry).
|
||||
- `SPECIAL_NONCE_ONLY_CONFIG` (69420) — skip node sync entirely, just config.
|
||||
- `SPECIAL_NONCE_ONLY_NODES` (69421) — skip config segments, jump straight to `STATE_SEND_OWN_NODEINFO`. Still gets the post-COMPLETE_ID replay drain.
|
||||
|
||||
There are no other reserved nonces; everything else is a fresh random `want_config_id` from the client.
|
||||
|
||||
### v24 → v25 migration
|
||||
|
||||
|
||||
+13
@@ -56,3 +56,16 @@ CMakeLists.txt
|
||||
.python3
|
||||
.claude/scheduled_tasks.lock
|
||||
userPrefs.jsonc.mcp-session-bak
|
||||
|
||||
# Fake-NodeDB fixture pipeline (bin/regen-fake-nodedbs.sh)
|
||||
# JSONL seeds are committed (test/fixtures/nodedb/seed_v25_*.jsonl);
|
||||
# compiled .proto outputs are ephemeral build artifacts.
|
||||
build/fixtures/
|
||||
bin/_generated/
|
||||
|
||||
# Build artifacts: anything compiling .o/.a outside .pio/ is accidental.
|
||||
# Explicit exceptions for vendored binaries (Morse Micro mm-iot-esp32 SDK).
|
||||
*.o
|
||||
*.a
|
||||
!lib/MorseWlan/lib/**/*.a
|
||||
!lib/MorseWlan/src/*.mbin.o
|
||||
|
||||
+8
-1
@@ -11,7 +11,7 @@ lint:
|
||||
- checkov@3.2.528
|
||||
- renovate@43.150.0
|
||||
- prettier@3.8.3
|
||||
- trufflehog@3.95.2
|
||||
- trufflehog@3.95.3
|
||||
- yamllint@1.38.0
|
||||
- bandit@1.9.4
|
||||
- trivy@0.70.0
|
||||
@@ -34,6 +34,13 @@ lint:
|
||||
- linters: [ALL]
|
||||
paths:
|
||||
- bin/**
|
||||
# Fake-NodeDB fixture JSONL files contain deterministic synthetic
|
||||
# public_key_hex (64-char hex) values that gitleaks misidentifies as
|
||||
# generic-api-key. These are not secrets — they're test fixtures
|
||||
# produced by bin/gen-fake-nodedb-seed.py with a fixed RNG seed.
|
||||
- linters: [gitleaks]
|
||||
paths:
|
||||
- test/fixtures/nodedb/seed_v25_*.jsonl
|
||||
runtimes:
|
||||
enabled:
|
||||
- python@3.14.4
|
||||
|
||||
Vendored
+4
-4
@@ -1,10 +1,10 @@
|
||||
{
|
||||
// See http://go.microsoft.com/fwlink/?LinkId=827846
|
||||
// for the documentation about the extensions.json format
|
||||
"recommendations": [
|
||||
"platformio.platformio-ide"
|
||||
"Jason2866.esp-decoder",
|
||||
"pioarduino.pioarduino-ide"
|
||||
],
|
||||
"unwantedRecommendations": [
|
||||
"ms-vscode.cpptools-extension-pack"
|
||||
"ms-vscode.cpptools-extension-pack",
|
||||
"platformio.platformio-ide"
|
||||
]
|
||||
}
|
||||
|
||||
Executable
+64
@@ -0,0 +1,64 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Post-process protoc-generated Python files to live under a local namespace.
|
||||
|
||||
Called by bin/regen-py-protos.sh. Walks the generated *_pb2.py files in the
|
||||
target directory and rewrites every `meshtastic` reference (imports, dotted
|
||||
attribute access) to use the new namespace (e.g., `meshtastic_v25`).
|
||||
|
||||
Why: the .proto files declare `package meshtastic;`, so protoc emits
|
||||
`from meshtastic import mesh_pb2 as ...` lines. That would shadow the PyPI
|
||||
`meshtastic` package which other parts of the mcp-server depend on. Renaming
|
||||
to a local namespace keeps both available.
|
||||
|
||||
Usage:
|
||||
_rewrite_proto_namespace.py <generated_dir> <new_namespace>
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import pathlib
|
||||
import re
|
||||
import sys
|
||||
|
||||
|
||||
def rewrite(dir_path: pathlib.Path, new_ns: str) -> int:
|
||||
# Standard protoc import forms:
|
||||
# from meshtastic.X_pb2 import ... (rare, for direct symbol pulls)
|
||||
# from meshtastic import X_pb2 as ... (common, the cross-file ref)
|
||||
# import meshtastic.X_pb2 (also possible)
|
||||
pattern_dotted_from = re.compile(r"^from meshtastic\.", re.MULTILINE)
|
||||
pattern_bare_from = re.compile(r"^from meshtastic import ", re.MULTILINE)
|
||||
pattern_dotted_import = re.compile(r"^import meshtastic\.", re.MULTILINE)
|
||||
|
||||
count = 0
|
||||
for p in dir_path.glob("*.py"):
|
||||
text = p.read_text(encoding="utf-8")
|
||||
new = pattern_dotted_from.sub(f"from {new_ns}.", text)
|
||||
new = pattern_bare_from.sub(f"from {new_ns} import ", new)
|
||||
new = pattern_dotted_import.sub(f"import {new_ns}.", new)
|
||||
# NOTE: we deliberately leave `meshtastic/X.proto` source-filename
|
||||
# references inside descriptor strings alone. The descriptor pool is
|
||||
# keyed by source filename (independent of Python package layout), so
|
||||
# those don't collide with the PyPI package's descriptors.
|
||||
if new != text:
|
||||
p.write_text(new, encoding="utf-8")
|
||||
count += 1
|
||||
return count
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
if len(argv) != 2:
|
||||
print("usage: _rewrite_proto_namespace.py <generated_dir> <new_namespace>", file=sys.stderr)
|
||||
return 2
|
||||
dir_path = pathlib.Path(argv[0])
|
||||
new_ns = argv[1]
|
||||
if not dir_path.is_dir():
|
||||
print(f"directory not found: {dir_path}", file=sys.stderr)
|
||||
return 2
|
||||
n = rewrite(dir_path, new_ns)
|
||||
print(f"rewrote {n} file(s) in {dir_path} → namespace {new_ns}", file=sys.stderr)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,18 @@
|
||||
# Station G3 motherboard with a Raspberry Pi Zero 2W as the MCU daughterboard.
|
||||
# Verify spidev / I2C device paths for your OS — they may differ.
|
||||
Meta:
|
||||
name: Station G3
|
||||
support: community
|
||||
compatible:
|
||||
- raspberry-pi
|
||||
|
||||
Lora:
|
||||
Module: sx1262
|
||||
IRQ: 22 # BCM pin — wiki spec
|
||||
Reset: 16 # BCM pin — wiki spec
|
||||
Busy: 24 # BCM pin — wiki spec
|
||||
# CS: 8 # BCM 8 = SPI0 CE0 (default); uncomment only to override
|
||||
DIO2_AS_RF_SWITCH: true
|
||||
DIO3_TCXO_VOLTAGE: true
|
||||
spidev: spidev0.0
|
||||
# SX126X_MAX_POWER: 19 # matches Station G2 firmware cap; raise carefully per PA jumper mode
|
||||
Executable
+439
@@ -0,0 +1,439 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Deterministic seed-data generator for the fake NodeDB fixture pipeline.
|
||||
|
||||
Writes a JSONL file describing N fake-but-realistic Meshtastic peers.
|
||||
The output is hand-editable and committed; a sibling compile step
|
||||
(bin/seed-json-to-proto.py) turns it into a binary `meshtastic_NodeDatabase`
|
||||
v25 protobuf with fresh "now-relative" timestamps.
|
||||
|
||||
Determinism contract:
|
||||
Same --seed -> byte-identical JSONL output, regardless of wall clock.
|
||||
All timestamps are stored as `*_offset_sec` (seconds before "now"); the
|
||||
compile step resolves them to absolute epochs at compile time.
|
||||
|
||||
Structural fields covered:
|
||||
* NodeInfoLite header: num, long_name, short_name, hw_model, role,
|
||||
public_key, snr, channel, hops_away, next_hop, bitfield flags
|
||||
* PositionLite: lat/long Gaussian around --centroid, altitude, source
|
||||
* DeviceMetrics: battery/voltage/util/uptime
|
||||
* EnvironmentMetrics: temp/humidity/pressure/iaq
|
||||
* StatusMessage: error_code (usually zero)
|
||||
|
||||
Active-board allow-list:
|
||||
hw_model values are restricted to the intersection of
|
||||
(a) variants with `custom_meshtastic_support_level = 1` in
|
||||
variants/*/*/platformio.ini, AND
|
||||
(b) values present in the `HardwareModel` enum in mesh.proto.
|
||||
See HW_MODEL_WEIGHTS below. Deprecated boards (legacy TLORA / Heltec V1-2 /
|
||||
classic TBEAM / TBEAM_V0P7 / Nano G1 / etc.) and fuzzer-only sentinels
|
||||
(PORTDUINO, ANDROID_SIM, DIY_V1, ...) are excluded.
|
||||
|
||||
Active-role allow-list:
|
||||
Excludes ROUTER_CLIENT (deprecated v2.3.15) and REPEATER (deprecated v2.7.11).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import datetime as _dt
|
||||
import json
|
||||
import math
|
||||
import pathlib
|
||||
import random
|
||||
import sys
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# Active-board allow-list (intersection of tier-1 variants + HardwareModel enum).
|
||||
# Refresh by running:
|
||||
# for f in $(find variants -name 'platformio.ini' | xargs grep -lE 'custom_meshtastic_support_level = 1'); do
|
||||
# grep custom_meshtastic_hw_model_slug $f | awk -F= '{print $2}' | tr -d ' ';
|
||||
# done | sort -u | comm -12 - <(python3 -c "from meshtastic.protobuf.mesh_pb2 import HardwareModel; print('\\n'.join(HardwareModel.keys()))" | sort)
|
||||
# --------------------------------------------------------------------------
|
||||
HW_MODEL_WEIGHTS: dict[str, float] = {
|
||||
"HELTEC_V3": 14.0,
|
||||
"T_DECK": 9.0,
|
||||
"HELTEC_V4": 8.0,
|
||||
"RAK4631": 8.0,
|
||||
"HELTEC_MESH_POCKET": 6.0,
|
||||
"TRACKER_T1000_E": 5.0,
|
||||
"HELTEC_MESH_NODE_T114": 5.0,
|
||||
"T_DECK_PRO": 5.0,
|
||||
"LILYGO_TBEAM_S3_CORE": 4.0,
|
||||
"HELTEC_WIRELESS_PAPER": 4.0,
|
||||
"HELTEC_WSL_V3": 3.0,
|
||||
"T_ECHO": 3.0,
|
||||
"HELTEC_WIRELESS_TRACKER": 3.0,
|
||||
"HELTEC_WIRELESS_TRACKER_V2": 2.0,
|
||||
"HELTEC_VISION_MASTER_E290": 2.0,
|
||||
"HELTEC_MESH_SOLAR": 2.0,
|
||||
"SEEED_WIO_TRACKER_L1": 2.0,
|
||||
"T_LORA_PAGER": 1.5,
|
||||
"HELTEC_VISION_MASTER_E213": 1.5,
|
||||
"T_ECHO_PLUS": 1.0,
|
||||
"MUZI_BASE": 1.0,
|
||||
"WISMESH_TAP_V2": 1.0,
|
||||
"THINKNODE_M2": 1.0,
|
||||
"THINKNODE_M5": 1.0,
|
||||
"TLORA_T3_S3": 1.0,
|
||||
# Long tail (uniform low weight across remaining tier-1 boards):
|
||||
"HELTEC_V4_R8": 0.3,
|
||||
"HELTEC_VISION_MASTER_T190": 0.3,
|
||||
"HELTEC_HT62": 0.3,
|
||||
"HELTEC_MESH_NODE_T096": 0.3,
|
||||
"M5STACK_C6L": 0.3,
|
||||
"MINI_EPAPER_S3": 0.3,
|
||||
"MUZI_R1_NEO": 0.3,
|
||||
"NOMADSTAR_METEOR_PRO": 0.3,
|
||||
"RAK3312": 0.3,
|
||||
"RAK3401": 0.3,
|
||||
"SEEED_SOLAR_NODE": 0.3,
|
||||
"SEEED_WIO_TRACKER_L1_EINK": 0.3,
|
||||
"SENSECAP_INDICATOR": 0.3,
|
||||
"TBEAM_1_WATT": 0.3,
|
||||
"THINKNODE_M1": 0.3,
|
||||
"THINKNODE_M3": 0.3,
|
||||
"THINKNODE_M6": 0.3,
|
||||
"T_ECHO_LITE": 0.3,
|
||||
"WISMESH_TAG": 0.3,
|
||||
"WISMESH_TAP": 0.3,
|
||||
"XIAO_NRF52_KIT": 0.3,
|
||||
"CROWPANEL": 0.3,
|
||||
}
|
||||
|
||||
# Non-deprecated roles only.
|
||||
ROLE_WEIGHTS: dict[str, float] = {
|
||||
"CLIENT": 75.0,
|
||||
"CLIENT_MUTE": 5.0,
|
||||
"ROUTER": 7.0,
|
||||
"TRACKER": 3.0,
|
||||
"SENSOR": 2.0,
|
||||
"CLIENT_HIDDEN": 2.0,
|
||||
"ROUTER_LATE": 2.0,
|
||||
"CLIENT_BASE": 2.0,
|
||||
"TAK": 1.0,
|
||||
"TAK_TRACKER": 0.5,
|
||||
"LOST_AND_FOUND": 0.5,
|
||||
}
|
||||
|
||||
# Name pools — 60 firsts × 60 lasts = 3600 combinations.
|
||||
FIRSTS = [
|
||||
"Quick", "Brave", "Silent", "Wild", "Lone", "Bright", "Red", "Blue",
|
||||
"Green", "Black", "White", "Iron", "Steel", "Copper", "Silver", "Gold",
|
||||
"Stone", "River", "Forest", "Mountain", "Canyon", "Desert", "Storm", "Sky",
|
||||
"Solar", "Lunar", "Dawn", "Dusk", "Misty", "Frosty", "Sunny", "Shady",
|
||||
"Happy", "Sleepy", "Drowsy", "Sneaky", "Sharp", "Smooth", "Rough", "Loud",
|
||||
"Soft", "Slow", "Fast", "Tall", "Short", "Old", "New", "Tiny",
|
||||
"Giant", "Hidden", "Lost", "Found", "Wandering", "Roving", "Drifting", "Floating",
|
||||
"Burning", "Frozen", "Whispering", "Howling",
|
||||
]
|
||||
LASTS = [
|
||||
"Phoenix", "Lion", "Bear", "Wolf", "Hawk", "Eagle", "Fox", "Lynx",
|
||||
"Cougar", "Coyote", "Raven", "Owl", "Crow", "Falcon", "Heron", "Crane",
|
||||
"Otter", "Badger", "Bison", "Elk", "Moose", "Stag", "Doe", "Hare",
|
||||
"Marmot", "Mole", "Beaver", "Squirrel", "Mustang", "Bronco", "Pony", "Colt",
|
||||
"Cobra", "Viper", "Mamba", "Adder", "Gecko", "Iguana", "Tortoise", "Turtle",
|
||||
"Salmon", "Trout", "Bass", "Pike", "Shark", "Whale", "Dolphin", "Seal",
|
||||
"Cactus", "Yucca", "Sage", "Juniper", "Pine", "Cedar", "Aspen", "Oak",
|
||||
"Bluff", "Mesa", "Arroyo", "Ridge",
|
||||
]
|
||||
|
||||
# Brief callsign pool for licensed-looking suffixes.
|
||||
CALLSIGN_PREFIXES = ["KX", "WD", "N5", "KE", "AB", "W5", "K1", "KQ", "AE", "NM"]
|
||||
|
||||
# Only emojis that fit in 4 UTF-8 bytes (no variation selectors). short_name's
|
||||
# nanopb max_size:5 (incl. NUL) limits content to 4 bytes. ❄️ / ☀️ would be
|
||||
# 6 bytes due to U+FE0F variation selector — explicitly excluded.
|
||||
EMOJI_SHORTNAMES = ["🦊", "🐺", "🦅", "🐢", "🌵", "🔥", "🌙",
|
||||
"🌊", "🗻", "🌲", "🦌", "🐝", "🦂", "🦉",
|
||||
"🦇", "🦋"]
|
||||
|
||||
# --------------------------------------------------------------------------
|
||||
# Helpers
|
||||
# --------------------------------------------------------------------------
|
||||
|
||||
NUM_RESERVED = 4 # firmware reserves 0..3 (per NodeDB constants)
|
||||
NUM_MAX_EXCLUSIVE = 0x80000000 # restrict to positive int32 range for readability
|
||||
|
||||
|
||||
def _weighted_choice(rng: random.Random, weights: dict[str, float]) -> str:
|
||||
"""Deterministic weighted pick. Uses sorted keys so dict order is fixed."""
|
||||
keys = sorted(weights.keys())
|
||||
totals = [weights[k] for k in keys]
|
||||
return rng.choices(keys, weights=totals, k=1)[0]
|
||||
|
||||
|
||||
def _gen_long_name(rng: random.Random, is_licensed: bool) -> str:
|
||||
base = f"{rng.choice(FIRSTS)} {rng.choice(LASTS)}"
|
||||
if is_licensed:
|
||||
prefix = rng.choice(CALLSIGN_PREFIXES)
|
||||
# Two trailing alpha chars after the digit; keep within 25 - len(base) - 1
|
||||
suffix = f" {prefix}{rng.randint(0,9)}{rng.choice('ABCDEFGHIJKLMNOPQRSTUVWXYZ')}{rng.choice('ABCDEFGHIJKLMNOPQRSTUVWXYZ')}"
|
||||
# nanopb max_size:25 means C string fits 24 bytes + NUL.
|
||||
if len(base) + len(suffix) <= 24:
|
||||
base = base + suffix
|
||||
# Hard cap to 24 chars (nanopb max_size:25 minus NUL).
|
||||
return base[:24]
|
||||
|
||||
|
||||
def _gen_short_name(rng: random.Random, long_name: str) -> str:
|
||||
# 10% emoji-only short_name
|
||||
if rng.random() < 0.10:
|
||||
return rng.choice(EMOJI_SHORTNAMES)
|
||||
first_char = long_name[0].upper() if long_name else "X"
|
||||
alphanums = "ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
|
||||
return first_char + "".join(rng.choices(alphanums, k=3))
|
||||
|
||||
|
||||
def _gen_hops_away(rng: random.Random) -> int:
|
||||
# Geometric-ish: 0→55%, 1→25%, 2→12%, 3→5%, 4→2%, 5+→1%
|
||||
r = rng.random()
|
||||
if r < 0.55:
|
||||
return 0
|
||||
if r < 0.80:
|
||||
return 1
|
||||
if r < 0.92:
|
||||
return 2
|
||||
if r < 0.97:
|
||||
return 3
|
||||
if r < 0.99:
|
||||
return 4
|
||||
return rng.randint(5, 7)
|
||||
|
||||
|
||||
def _gen_position(
|
||||
rng: random.Random,
|
||||
centroid_lat: float,
|
||||
centroid_lon: float,
|
||||
spread_km: float,
|
||||
last_heard_offset_sec: int,
|
||||
) -> dict:
|
||||
# 1 deg ≈ 111 km at the equator; we use this as a flat approximation.
|
||||
lat = centroid_lat + rng.gauss(0.0, spread_km / 111.0)
|
||||
lon = centroid_lon + rng.gauss(0.0, spread_km / 111.0)
|
||||
altitude = max(0, round(rng.gauss(1376.0, 250.0))) # T or C valley floor + relief
|
||||
# Position was reported up to 300s before last_heard.
|
||||
time_offset_sec = last_heard_offset_sec + rng.randint(0, 300)
|
||||
return {
|
||||
"latitude": round(lat, 6),
|
||||
"longitude": round(lon, 6),
|
||||
"altitude": altitude,
|
||||
"time_offset_sec": time_offset_sec,
|
||||
"location_source": "LOC_INTERNAL",
|
||||
}
|
||||
|
||||
|
||||
def _gen_telemetry(rng: random.Random) -> dict:
|
||||
# 5% plugged-in (battery_level == 101); rest uniform [10..100].
|
||||
if rng.random() < 0.05:
|
||||
battery_level = 101
|
||||
voltage = 4.20
|
||||
else:
|
||||
battery_level = rng.randint(10, 100)
|
||||
voltage = round(3.3 + (battery_level / 100.0) * 0.9, 3)
|
||||
# Beta distributions for low/right-skewed metrics; randomly draw via gammavariate.
|
||||
def _beta(a: float, b: float) -> float:
|
||||
x = rng.gammavariate(a, 1.0)
|
||||
y = rng.gammavariate(b, 1.0)
|
||||
return x / (x + y)
|
||||
channel_utilization = round(_beta(2.0, 15.0) * 100.0, 2)
|
||||
air_util_tx = round(_beta(1.5, 20.0) * 10.0, 3)
|
||||
uptime_seconds = int(rng.expovariate(1.0 / 86400.0))
|
||||
return {
|
||||
"battery_level": battery_level,
|
||||
"voltage": voltage,
|
||||
"channel_utilization": channel_utilization,
|
||||
"air_util_tx": air_util_tx,
|
||||
"uptime_seconds": uptime_seconds,
|
||||
}
|
||||
|
||||
|
||||
def _gen_environment(rng: random.Random) -> dict:
|
||||
return {
|
||||
"temperature": round(rng.gauss(22.0, 8.0), 2),
|
||||
"relative_humidity": round(min(100.0, max(0.0, rng.gauss(55.0, 20.0))), 2),
|
||||
"barometric_pressure": round(rng.gauss(1013.0, 8.0), 2),
|
||||
"iaq": int(min(500, max(0, round(rng.gauss(50.0, 30.0))))),
|
||||
}
|
||||
|
||||
|
||||
def _gen_status(rng: random.Random) -> dict:
|
||||
# `StatusMessage` (mesh.proto:1445) has a single free-form `string status`.
|
||||
# Most peers report a healthy short status; occasional alert string.
|
||||
healthy = ["OK", "online", "active", "running", "ready", "nominal"]
|
||||
alert = ["low-batt", "no-gps", "weak-signal", "rebooted", "offline-soon"]
|
||||
if rng.random() < 0.92:
|
||||
return {"status": rng.choice(healthy)}
|
||||
return {"status": rng.choice(alert)}
|
||||
|
||||
|
||||
def _gen_node(
|
||||
rng: random.Random,
|
||||
num: int,
|
||||
centroid_lat: float,
|
||||
centroid_lon: float,
|
||||
spread_km: float,
|
||||
coverage: dict[str, float],
|
||||
last_heard_mean_sec: int,
|
||||
last_heard_max_sec: int,
|
||||
) -> dict:
|
||||
is_licensed = rng.random() < 0.05
|
||||
long_name = _gen_long_name(rng, is_licensed)
|
||||
short_name = _gen_short_name(rng, long_name)
|
||||
hw_model = _weighted_choice(rng, HW_MODEL_WEIGHTS)
|
||||
role = _weighted_choice(rng, ROLE_WEIGHTS)
|
||||
has_public_key = rng.random() < 0.92
|
||||
public_key_hex = (
|
||||
"".join(f"{rng.randint(0,255):02x}" for _ in range(32)) if has_public_key else ""
|
||||
)
|
||||
snr = round(max(-20.0, min(12.0, rng.gauss(6.0, 4.0))), 2)
|
||||
channel = 0 if rng.random() < 0.90 else rng.randint(1, 7)
|
||||
hops_away = _gen_hops_away(rng)
|
||||
next_hop = rng.randint(0, 255) if hops_away > 0 else 0
|
||||
last_heard_offset_sec = int(min(rng.expovariate(1.0 / last_heard_mean_sec), last_heard_max_sec))
|
||||
|
||||
bitfield = {
|
||||
"has_user": True,
|
||||
"is_favorite": rng.random() < 0.08,
|
||||
"is_muted": rng.random() < 0.03,
|
||||
"via_mqtt": rng.random() < 0.12,
|
||||
"is_ignored": rng.random() < 0.01,
|
||||
"is_licensed": is_licensed,
|
||||
"has_is_unmessagable": True,
|
||||
"is_unmessagable": rng.random() < 0.02,
|
||||
"is_key_manually_verified": rng.random() < 0.04,
|
||||
}
|
||||
|
||||
node: dict = {
|
||||
"num": f"0x{num:08x}",
|
||||
"long_name": long_name,
|
||||
"short_name": short_name,
|
||||
"hw_model": hw_model,
|
||||
"role": role,
|
||||
"public_key_hex": public_key_hex,
|
||||
"snr": snr,
|
||||
"channel": channel,
|
||||
"hops_away": hops_away,
|
||||
"next_hop": next_hop,
|
||||
"last_heard_offset_sec": last_heard_offset_sec,
|
||||
"bitfield": bitfield,
|
||||
"position": (
|
||||
_gen_position(rng, centroid_lat, centroid_lon, spread_km, last_heard_offset_sec)
|
||||
if rng.random() < coverage["position"]
|
||||
else None
|
||||
),
|
||||
"telemetry": _gen_telemetry(rng) if rng.random() < coverage["telemetry"] else None,
|
||||
"environment": _gen_environment(rng) if rng.random() < coverage["environment"] else None,
|
||||
"status": _gen_status(rng) if rng.random() < coverage["status"] else None,
|
||||
}
|
||||
return node
|
||||
|
||||
|
||||
def _parse_my_node_num(s: str | None) -> int | None:
|
||||
if s is None:
|
||||
return None
|
||||
s = s.strip()
|
||||
if s.startswith("0x") or s.startswith("0X"):
|
||||
return int(s, 16)
|
||||
return int(s)
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
p = argparse.ArgumentParser(
|
||||
description="Deterministic JSONL seed for the fake NodeDB fixture.",
|
||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||||
)
|
||||
p.add_argument("--count", type=int, required=True, help="Number of fake nodes to emit.")
|
||||
p.add_argument("--seed", type=int, required=True, help="Deterministic seed.")
|
||||
p.add_argument("--out", required=True, help="Output JSONL path.")
|
||||
p.add_argument(
|
||||
"--centroid",
|
||||
default="33.1284,-107.2528",
|
||||
help="LAT,LON centroid (default: Truth or Consequences, NM).",
|
||||
)
|
||||
p.add_argument("--spread-km", type=float, default=60.0, help="Gaussian std-dev in km.")
|
||||
p.add_argument("--position-coverage", type=float, default=0.85)
|
||||
p.add_argument("--telemetry-coverage", type=float, default=0.70)
|
||||
p.add_argument("--environment-coverage", type=float, default=0.25)
|
||||
p.add_argument("--status-coverage", type=float, default=0.40)
|
||||
p.add_argument("--my-node-num", default=None, help="Exclude this NodeNum from generated set (hex or dec).")
|
||||
p.add_argument("--last-heard-mean-sec", type=int, default=3600)
|
||||
p.add_argument("--last-heard-max-sec", type=int, default=7 * 86400)
|
||||
args = p.parse_args(argv)
|
||||
|
||||
if args.count <= 0:
|
||||
print("--count must be positive", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
try:
|
||||
centroid_lat, centroid_lon = (float(s) for s in args.centroid.split(","))
|
||||
except ValueError:
|
||||
print(f"--centroid must be LAT,LON; got {args.centroid!r}", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
my_node_num = _parse_my_node_num(args.my_node_num)
|
||||
|
||||
rng = random.Random(args.seed)
|
||||
|
||||
# 1) Generate a unique deterministic set of NodeNums.
|
||||
nums: set[int] = set()
|
||||
while len(nums) < args.count:
|
||||
n = rng.randrange(NUM_RESERVED, NUM_MAX_EXCLUSIVE)
|
||||
if my_node_num is not None and n == my_node_num:
|
||||
continue
|
||||
nums.add(n)
|
||||
ordered_nums = sorted(nums) # sort to fix output order independent of set hash
|
||||
|
||||
# 2) Per-node generation (in num order, single RNG continues).
|
||||
coverage = {
|
||||
"position": args.position_coverage,
|
||||
"telemetry": args.telemetry_coverage,
|
||||
"environment": args.environment_coverage,
|
||||
"status": args.status_coverage,
|
||||
}
|
||||
nodes = [
|
||||
_gen_node(
|
||||
rng,
|
||||
n,
|
||||
centroid_lat,
|
||||
centroid_lon,
|
||||
args.spread_km,
|
||||
coverage,
|
||||
args.last_heard_mean_sec,
|
||||
args.last_heard_max_sec,
|
||||
)
|
||||
for n in ordered_nums
|
||||
]
|
||||
|
||||
# 3) Write JSONL.
|
||||
out_path = pathlib.Path(args.out)
|
||||
out_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
# `generated_at_iso` is informational; it does NOT affect determinism because
|
||||
# we derive it from the seed, not from wall clock. (Same seed -> same string.)
|
||||
generated_at = _dt.datetime.fromtimestamp(args.seed, tz=_dt.timezone.utc).isoformat().replace("+00:00", "Z")
|
||||
meta = {
|
||||
"_meta": {
|
||||
"version": 25,
|
||||
"seed": args.seed,
|
||||
"count": args.count,
|
||||
"centroid": [centroid_lat, centroid_lon],
|
||||
"spread_km": args.spread_km,
|
||||
"generated_at_iso": generated_at,
|
||||
"my_node_num_excluded": (None if my_node_num is None else f"0x{my_node_num:08x}"),
|
||||
"coverage": coverage,
|
||||
"last_heard_mean_sec": args.last_heard_mean_sec,
|
||||
"last_heard_max_sec": args.last_heard_max_sec,
|
||||
}
|
||||
}
|
||||
with out_path.open("w", encoding="utf-8") as f:
|
||||
# `ensure_ascii=False` so emoji short_names survive. `sort_keys=True` for
|
||||
# determinism (insertion order varies by Python version otherwise).
|
||||
f.write(json.dumps(meta, ensure_ascii=False, sort_keys=True) + "\n")
|
||||
for node in nodes:
|
||||
f.write(json.dumps(node, ensure_ascii=False, sort_keys=True) + "\n")
|
||||
|
||||
print(f"wrote {args.count} nodes to {out_path} ({out_path.stat().st_size} bytes)", file=sys.stderr)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
Executable
+73
@@ -0,0 +1,73 @@
|
||||
#!/usr/bin/env bash
|
||||
# Regenerate the fake-NodeDB fixtures: produces 250 / 500 / 1000 / 2000-node
|
||||
# JSONL seed files + their compiled v25 protobufs.
|
||||
#
|
||||
# Layout:
|
||||
# test/fixtures/nodedb/seed_v25_<N>.jsonl — COMMITTED, hand-editable.
|
||||
# build/fixtures/nodedb/nodes_v25_<N>.proto — .gitignored, build artifact.
|
||||
# Drop into /prefs/nodes.proto.
|
||||
#
|
||||
# Daily use: ./bin/regen-fake-nodedbs.sh
|
||||
# - Recompiles protos from committed seeds (fresh wall-clock timestamps).
|
||||
# Intentional seed bump: REGEN_SEEDS=yes ./bin/regen-fake-nodedbs.sh
|
||||
# - Overwrites the committed JSONL files with freshly-seeded data.
|
||||
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
# 1) Make sure the Python protobuf bindings exist (in-tree generation; .gitignored).
|
||||
if [[ ! -d bin/_generated/meshtastic ]]; then
|
||||
echo "regenerating Python protobuf bindings (one-time)..."
|
||||
./bin/regen-py-protos.sh
|
||||
fi
|
||||
|
||||
# 2) Pick a Python interpreter that has the meshtastic deps installed.
|
||||
# Prefer the mcp-server venv (most likely to be set up by the operator).
|
||||
PY="python3"
|
||||
for cand in mcp-server/.venv/bin/python3 .venv/bin/python3; do
|
||||
if [[ -x "$cand" ]]; then
|
||||
PY="$cand"
|
||||
break
|
||||
fi
|
||||
done
|
||||
|
||||
# 3) Pinned seeds per size — bump only when you intentionally want different
|
||||
# structural data committed. Parallel arrays so the script works on
|
||||
# macOS bash 3.2 (no `declare -A`).
|
||||
SIZES=(250 500 1000 2000)
|
||||
SEEDS=(20260511 20260512 20260513 20260514)
|
||||
|
||||
REGEN_SEEDS="${REGEN_SEEDS:-no}"
|
||||
|
||||
mkdir -p build/fixtures/nodedb test/fixtures/nodedb
|
||||
|
||||
for i in 0 1 2 3; do
|
||||
n="${SIZES[$i]}"
|
||||
seed="${SEEDS[$i]}"
|
||||
jsonl=$(printf "test/fixtures/nodedb/seed_v25_%04d.jsonl" "$n")
|
||||
proto=$(printf "build/fixtures/nodedb/nodes_v25_%04d.proto" "$n")
|
||||
|
||||
if [[ "$REGEN_SEEDS" == "yes" || ! -f "$jsonl" ]]; then
|
||||
$PY bin/gen-fake-nodedb-seed.py \
|
||||
--count "$n" \
|
||||
--seed "$seed" \
|
||||
--out "$jsonl" \
|
||||
--centroid 33.1284,-107.2528 \
|
||||
--spread-km 60 \
|
||||
--position-coverage 0.85 \
|
||||
--telemetry-coverage 0.70 \
|
||||
--environment-coverage 0.25 \
|
||||
--status-coverage 0.40
|
||||
echo " seed: $jsonl ($(wc -c < "$jsonl") bytes)"
|
||||
fi
|
||||
|
||||
$PY bin/seed-json-to-proto.py --in "$jsonl" --out "$proto"
|
||||
echo " proto: $proto ($(wc -c < "$proto") bytes)"
|
||||
done
|
||||
|
||||
echo ""
|
||||
echo "Done. To load on Portduino native:"
|
||||
echo " cp build/fixtures/nodedb/nodes_v25_1000.proto ~/.portduino/default/prefs/nodes.proto"
|
||||
echo ""
|
||||
echo "To push to a hardware device:"
|
||||
echo " Use the mcp-server tool: push_fake_nodedb(size=1000, target=\"hardware\", port=\"/dev/cu.usbmodemXXXX\", confirm=True)"
|
||||
Executable
+51
@@ -0,0 +1,51 @@
|
||||
#!/usr/bin/env bash
|
||||
# Regenerate Python protobuf bindings from the in-tree `protobufs/` submodule
|
||||
# into `bin/_generated/`. Called by bin/regen-fake-nodedbs.sh; also useful as
|
||||
# a standalone refresh after any change to a .proto file.
|
||||
#
|
||||
# Output is .gitignored — bindings are a build artifact.
|
||||
#
|
||||
# Namespace rewrite:
|
||||
# The .proto files declare `package meshtastic;`, which makes protoc emit
|
||||
# imports like `from meshtastic import mesh_pb2`. That conflicts with the
|
||||
# PyPI `meshtastic` package (which the mcp-server relies on for its
|
||||
# SerialInterface/BLEInterface transport). We post-process the generated
|
||||
# files to live under `meshtastic_v25` instead — both the directory layout
|
||||
# and all internal imports — so they coexist cleanly with the PyPI package.
|
||||
|
||||
set -euo pipefail
|
||||
cd "$(dirname "$0")/.."
|
||||
|
||||
if ! command -v protoc >/dev/null 2>&1; then
|
||||
echo "ERROR: protoc not found in PATH." >&2
|
||||
echo " macOS: brew install protobuf" >&2
|
||||
echo " Ubuntu/Debian: apt install protobuf-compiler" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
OUT=bin/_generated
|
||||
LOCAL_NS=meshtastic_v25
|
||||
|
||||
rm -rf "$OUT"
|
||||
mkdir -p "$OUT"
|
||||
|
||||
# 1) Generate from the in-tree protos. nanopb.proto first so its descriptor
|
||||
# is available for the [(nanopb).*] options on other messages.
|
||||
protoc \
|
||||
--proto_path=protobufs \
|
||||
--python_out="$OUT" \
|
||||
protobufs/nanopb.proto \
|
||||
protobufs/meshtastic/*.proto
|
||||
|
||||
# 2) Move the generated `meshtastic/` directory to `meshtastic_v25/`.
|
||||
mv "$OUT/meshtastic" "$OUT/$LOCAL_NS"
|
||||
|
||||
# 3) Rewrite internal imports: any reference to `meshtastic.X_pb2` or
|
||||
# `from meshtastic import X_pb2` becomes `meshtastic_v25.*`.
|
||||
python3 bin/_rewrite_proto_namespace.py "$OUT/$LOCAL_NS" "$LOCAL_NS"
|
||||
|
||||
# 4) Make the package importable.
|
||||
touch "$OUT/__init__.py"
|
||||
touch "$OUT/$LOCAL_NS/__init__.py"
|
||||
|
||||
echo "regenerated Python protobuf bindings -> $OUT/$LOCAL_NS/ (namespace: $LOCAL_NS)" >&2
|
||||
Executable
+342
@@ -0,0 +1,342 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Compile a committed seed JSONL into a binary meshtastic_NodeDatabase v25 proto.
|
||||
|
||||
The input is produced by `bin/gen-fake-nodedb-seed.py`. Timestamps in the JSONL
|
||||
are stored as `*_offset_sec` (seconds before "now"); this script resolves them
|
||||
to absolute epochs using `--now-epoch` (default: current wall clock).
|
||||
|
||||
Output is a raw `pb_encode`-compatible binary that can be dropped at
|
||||
`/prefs/nodes.proto` on the device (Portduino prefs dir or hardware via
|
||||
XModem) and loaded by `NodeDB::loadFromDisk` at boot.
|
||||
|
||||
Wire format reference:
|
||||
protobufs/meshtastic/deviceonly.proto (NodeDatabase, NodeInfoLite, sat entries)
|
||||
src/mesh/NodeDB.h:467-484 (bitfield bit positions)
|
||||
src/mesh/NodeDB.cpp:1523-1524 (pb_decode entry point)
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import pathlib
|
||||
import sys
|
||||
import time
|
||||
from typing import Any
|
||||
|
||||
# Prefer the in-tree generated Python protobuf bindings (bin/_generated/meshtastic_v25/)
|
||||
# because the firmware branch's protos (v25 NodeDatabase satellite arrays, slim
|
||||
# NodeInfoLite) are typically newer than what the PyPI `meshtastic` package
|
||||
# ships. Run `bin/regen-py-protos.sh` to (re)generate.
|
||||
#
|
||||
# Namespace note: the local bindings live under `meshtastic_v25` (NOT `meshtastic`)
|
||||
# to avoid shadowing the PyPI `meshtastic` package — bin/regen-py-protos.sh
|
||||
# post-processes the protoc output to rename the package.
|
||||
_HERE = pathlib.Path(__file__).resolve().parent
|
||||
_LOCAL_PROTO_DIR = _HERE / "_generated"
|
||||
if _LOCAL_PROTO_DIR.is_dir():
|
||||
sys.path.insert(0, str(_LOCAL_PROTO_DIR))
|
||||
|
||||
try:
|
||||
from meshtastic_v25.deviceonly_pb2 import ( # type: ignore[import-not-found]
|
||||
NodeDatabase,
|
||||
NodeInfoLite,
|
||||
NodePositionEntry,
|
||||
NodeTelemetryEntry,
|
||||
NodeEnvironmentEntry,
|
||||
NodeStatusEntry,
|
||||
PositionLite,
|
||||
)
|
||||
from meshtastic_v25.mesh_pb2 import HardwareModel, Position, StatusMessage # type: ignore[import-not-found]
|
||||
from meshtastic_v25.config_pb2 import Config # type: ignore[import-not-found]
|
||||
from meshtastic_v25.telemetry_pb2 import DeviceMetrics, EnvironmentMetrics # type: ignore[import-not-found]
|
||||
except ImportError as local_err:
|
||||
# Fall back to the PyPI package if in-tree bindings haven't been generated.
|
||||
# Will fail the v25 assertion below if the PyPI package predates the
|
||||
# satellite-DB schema, but at least gives a clear "run regen-py-protos.sh"
|
||||
# error message instead of an opaque ImportError.
|
||||
try:
|
||||
from meshtastic.protobuf.deviceonly_pb2 import (
|
||||
NodeDatabase,
|
||||
NodeInfoLite,
|
||||
NodePositionEntry,
|
||||
NodeTelemetryEntry,
|
||||
NodeEnvironmentEntry,
|
||||
NodeStatusEntry,
|
||||
PositionLite,
|
||||
)
|
||||
from meshtastic.protobuf.mesh_pb2 import HardwareModel, Position, StatusMessage
|
||||
from meshtastic.protobuf.config_pb2 import Config
|
||||
from meshtastic.protobuf.telemetry_pb2 import DeviceMetrics, EnvironmentMetrics
|
||||
except ImportError as pypi_err:
|
||||
print(
|
||||
"ERROR: could not import meshtastic protobuf bindings.\n"
|
||||
" In-tree generation: run `bin/regen-py-protos.sh` (requires protoc).\n"
|
||||
" PyPI fallback: `pip install meshtastic` (may lag firmware branch).\n"
|
||||
f" local error (meshtastic_v25): {local_err}\n"
|
||||
f" pypi error (meshtastic.protobuf): {pypi_err}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
sys.exit(1)
|
||||
|
||||
# Fail loudly if bindings predate v25 (no satellite arrays).
|
||||
assert (
|
||||
hasattr(NodeDatabase, "DESCRIPTOR")
|
||||
and "positions" in NodeDatabase.DESCRIPTOR.fields_by_name
|
||||
), (
|
||||
"Loaded meshtastic bindings are older than v25 (NodeDatabase.positions missing). "
|
||||
"Run `bin/regen-py-protos.sh` against the in-tree protobufs/ submodule."
|
||||
)
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Bitfield bit positions (mirror src/mesh/NodeDB.h:467-484).
|
||||
# ---------------------------------------------------------------------------
|
||||
BIT_IS_KEY_MANUALLY_VERIFIED = 0
|
||||
BIT_IS_MUTED = 1
|
||||
BIT_VIA_MQTT = 2
|
||||
BIT_IS_FAVORITE = 3
|
||||
BIT_IS_IGNORED = 4
|
||||
BIT_HAS_USER = 5
|
||||
BIT_IS_LICENSED = 6
|
||||
BIT_IS_UNMESSAGABLE = 7
|
||||
BIT_HAS_IS_UNMESSAGABLE = 8
|
||||
|
||||
BITFIELD_LAYOUT = (
|
||||
# JSON key bit position
|
||||
("is_key_manually_verified", BIT_IS_KEY_MANUALLY_VERIFIED),
|
||||
("is_muted", BIT_IS_MUTED),
|
||||
("via_mqtt", BIT_VIA_MQTT),
|
||||
("is_favorite", BIT_IS_FAVORITE),
|
||||
("is_ignored", BIT_IS_IGNORED),
|
||||
("has_user", BIT_HAS_USER),
|
||||
("is_licensed", BIT_IS_LICENSED),
|
||||
("is_unmessagable", BIT_IS_UNMESSAGABLE),
|
||||
("has_is_unmessagable", BIT_HAS_IS_UNMESSAGABLE),
|
||||
)
|
||||
|
||||
|
||||
def _pack_bitfield(bf: dict[str, bool]) -> int:
|
||||
out = 0
|
||||
for key, shift in BITFIELD_LAYOUT:
|
||||
if bf.get(key, False):
|
||||
out |= (1 << shift)
|
||||
return out
|
||||
|
||||
|
||||
def _validate_node(node: dict[str, Any]) -> None:
|
||||
"""Friendly errors so hand-editors get clear feedback."""
|
||||
if "num" not in node or not isinstance(node["num"], str):
|
||||
raise ValueError(f"node missing/invalid 'num' (must be hex string): {node!r}")
|
||||
if "long_name" not in node:
|
||||
raise ValueError(f"node {node['num']}: missing 'long_name'")
|
||||
if len(node["long_name"]) > 24:
|
||||
raise ValueError(
|
||||
f"node {node['num']}: long_name {node['long_name']!r} is "
|
||||
f"{len(node['long_name'])} chars; max 24 (nanopb max_size:25 minus NUL)"
|
||||
)
|
||||
if "short_name" in node:
|
||||
# short_name max_size:5 (incl. NUL) → 4 bytes of content.
|
||||
# Char count is irrelevant — emojis with variation selectors (e.g. ❄️ = 6 B)
|
||||
# would slip past a `len(str) > 4` check. Always measure bytes.
|
||||
b = node["short_name"].encode("utf-8")
|
||||
if len(b) > 4:
|
||||
raise ValueError(
|
||||
f"node {node['num']}: short_name {node['short_name']!r} is "
|
||||
f"{len(b)} bytes UTF-8; max 4 (nanopb max_size:5 minus NUL)"
|
||||
)
|
||||
pk = node.get("public_key_hex", "")
|
||||
if pk and len(pk) != 64:
|
||||
raise ValueError(
|
||||
f"node {node['num']}: public_key_hex must be 64 hex chars or empty; "
|
||||
f"got {len(pk)} chars"
|
||||
)
|
||||
if pk:
|
||||
try:
|
||||
bytes.fromhex(pk)
|
||||
except ValueError as e:
|
||||
raise ValueError(f"node {node['num']}: public_key_hex is not valid hex: {e}")
|
||||
|
||||
|
||||
def _resolve_time(
|
||||
node: dict[str, Any],
|
||||
field_absolute: str,
|
||||
field_offset: str,
|
||||
now_epoch: int,
|
||||
) -> int:
|
||||
"""If `field_absolute` is set, use it; else compute `now_epoch - offset`."""
|
||||
if field_absolute in node and node[field_absolute] is not None:
|
||||
return int(node[field_absolute])
|
||||
offset = node.get(field_offset, 0)
|
||||
return max(0, int(now_epoch) - int(offset))
|
||||
|
||||
|
||||
def _build_node_info_lite(node: dict[str, Any], now_epoch: int) -> NodeInfoLite:
|
||||
_validate_node(node)
|
||||
info = NodeInfoLite()
|
||||
info.num = int(node["num"], 16) if isinstance(node["num"], str) else int(node["num"])
|
||||
info.long_name = node.get("long_name", "")
|
||||
info.short_name = node.get("short_name", "")
|
||||
# Enum lookups will raise ValueError on unknown names — that's exactly what we want.
|
||||
info.hw_model = HardwareModel.Value(node.get("hw_model", "UNSET"))
|
||||
info.role = Config.DeviceConfig.Role.Value(node.get("role", "CLIENT"))
|
||||
pk_hex = node.get("public_key_hex", "")
|
||||
if pk_hex:
|
||||
info.public_key = bytes.fromhex(pk_hex)
|
||||
info.snr = float(node.get("snr", 0.0))
|
||||
info.channel = int(node.get("channel", 0))
|
||||
if "hops_away" in node:
|
||||
# `optional uint32 hops_away = 9;` — in Python protobuf, assigning the
|
||||
# field implicitly sets HasField("hops_away") to True. No has_hops_away
|
||||
# setter exists (unlike the C++ nanopb-generated header).
|
||||
info.hops_away = int(node["hops_away"])
|
||||
info.next_hop = int(node.get("next_hop", 0))
|
||||
info.last_heard = _resolve_time(node, "last_heard", "last_heard_offset_sec", now_epoch)
|
||||
info.bitfield = _pack_bitfield(node.get("bitfield", {}))
|
||||
return info
|
||||
|
||||
|
||||
def _build_position_entry(num: int, pos: dict[str, Any], now_epoch: int) -> NodePositionEntry:
|
||||
entry = NodePositionEntry()
|
||||
entry.num = num
|
||||
pl = PositionLite()
|
||||
# Firmware stores lat/long as int32 in 1e-7 degrees.
|
||||
pl.latitude_i = int(round(float(pos["latitude"]) * 1e7))
|
||||
pl.longitude_i = int(round(float(pos["longitude"]) * 1e7))
|
||||
pl.altitude = int(pos.get("altitude", 0))
|
||||
pl.time = _resolve_time(pos, "time", "time_offset_sec", now_epoch)
|
||||
pl.location_source = Position.LocSource.Value(pos.get("location_source", "LOC_UNSET"))
|
||||
entry.position.CopyFrom(pl)
|
||||
return entry
|
||||
|
||||
|
||||
def _build_telemetry_entry(num: int, tel: dict[str, Any]) -> NodeTelemetryEntry:
|
||||
entry = NodeTelemetryEntry()
|
||||
entry.num = num
|
||||
dm = DeviceMetrics()
|
||||
if "battery_level" in tel:
|
||||
dm.battery_level = int(tel["battery_level"])
|
||||
if "voltage" in tel:
|
||||
dm.voltage = float(tel["voltage"])
|
||||
if "channel_utilization" in tel:
|
||||
dm.channel_utilization = float(tel["channel_utilization"])
|
||||
if "air_util_tx" in tel:
|
||||
dm.air_util_tx = float(tel["air_util_tx"])
|
||||
if "uptime_seconds" in tel:
|
||||
dm.uptime_seconds = int(tel["uptime_seconds"])
|
||||
entry.device_metrics.CopyFrom(dm)
|
||||
return entry
|
||||
|
||||
|
||||
def _build_environment_entry(num: int, env: dict[str, Any]) -> NodeEnvironmentEntry:
|
||||
entry = NodeEnvironmentEntry()
|
||||
entry.num = num
|
||||
em = EnvironmentMetrics()
|
||||
if "temperature" in env:
|
||||
em.temperature = float(env["temperature"])
|
||||
if "relative_humidity" in env:
|
||||
em.relative_humidity = float(env["relative_humidity"])
|
||||
if "barometric_pressure" in env:
|
||||
em.barometric_pressure = float(env["barometric_pressure"])
|
||||
if "iaq" in env:
|
||||
em.iaq = int(env["iaq"])
|
||||
entry.environment_metrics.CopyFrom(em)
|
||||
return entry
|
||||
|
||||
|
||||
def _build_status_entry(num: int, status: dict[str, Any]) -> NodeStatusEntry:
|
||||
# `StatusMessage` (mesh.proto:1445) has a single `string status` field.
|
||||
entry = NodeStatusEntry()
|
||||
entry.num = num
|
||||
sm = StatusMessage()
|
||||
if "status" in status:
|
||||
sm.status = str(status["status"])
|
||||
entry.status.CopyFrom(sm)
|
||||
return entry
|
||||
|
||||
|
||||
def compile_jsonl_to_proto(jsonl_path: pathlib.Path, now_epoch: int) -> bytes:
|
||||
"""Read a seed JSONL and return the encoded NodeDatabase bytes."""
|
||||
lines = jsonl_path.read_text(encoding="utf-8").splitlines()
|
||||
if not lines:
|
||||
raise ValueError(f"{jsonl_path} is empty")
|
||||
meta_line = lines[0]
|
||||
meta_obj = json.loads(meta_line)
|
||||
meta = meta_obj.get("_meta", {})
|
||||
version = meta.get("version")
|
||||
if version != 25:
|
||||
raise ValueError(
|
||||
f"{jsonl_path}: meta version is {version!r}; this compiler "
|
||||
f"requires version=25. Regenerate the seed with the matching tooling."
|
||||
)
|
||||
|
||||
db = NodeDatabase()
|
||||
db.version = 25
|
||||
|
||||
for ln, raw in enumerate(lines[1:], start=2):
|
||||
raw = raw.strip()
|
||||
if not raw:
|
||||
continue
|
||||
try:
|
||||
node = json.loads(raw)
|
||||
except json.JSONDecodeError as e:
|
||||
raise ValueError(f"{jsonl_path}:{ln} JSON parse error: {e}")
|
||||
|
||||
num = int(node["num"], 16) if isinstance(node["num"], str) else int(node["num"])
|
||||
|
||||
# Header
|
||||
info = _build_node_info_lite(node, now_epoch)
|
||||
db.nodes.append(info)
|
||||
|
||||
# Satellites (nullable)
|
||||
if node.get("position"):
|
||||
db.positions.append(_build_position_entry(num, node["position"], now_epoch))
|
||||
if node.get("telemetry"):
|
||||
db.telemetry.append(_build_telemetry_entry(num, node["telemetry"]))
|
||||
if node.get("environment"):
|
||||
db.environment.append(_build_environment_entry(num, node["environment"]))
|
||||
if node.get("status"):
|
||||
db.status.append(_build_status_entry(num, node["status"]))
|
||||
|
||||
return db.SerializeToString()
|
||||
|
||||
|
||||
def main(argv: list[str]) -> int:
|
||||
p = argparse.ArgumentParser(
|
||||
description="Compile a seed JSONL into a binary v25 NodeDatabase proto.",
|
||||
formatter_class=argparse.ArgumentDefaultsHelpFormatter,
|
||||
)
|
||||
p.add_argument("--in", dest="in_path", required=True, help="Input seed JSONL.")
|
||||
p.add_argument("--out", required=True, help="Output binary .proto path.")
|
||||
p.add_argument(
|
||||
"--now-epoch",
|
||||
type=int,
|
||||
default=None,
|
||||
help="Pin 'now' to this Unix epoch (for byte-identical CI). Default: time.time().",
|
||||
)
|
||||
args = p.parse_args(argv)
|
||||
|
||||
in_path = pathlib.Path(args.in_path)
|
||||
if not in_path.is_file():
|
||||
print(f"input not found: {in_path}", file=sys.stderr)
|
||||
return 2
|
||||
|
||||
now_epoch = args.now_epoch if args.now_epoch is not None else int(time.time())
|
||||
|
||||
try:
|
||||
encoded = compile_jsonl_to_proto(in_path, now_epoch)
|
||||
except ValueError as e:
|
||||
print(f"ERROR: {e}", file=sys.stderr)
|
||||
return 3
|
||||
|
||||
out_path = pathlib.Path(args.out)
|
||||
out_path.parent.mkdir(parents=True, exist_ok=True)
|
||||
out_path.write_bytes(encoded)
|
||||
print(
|
||||
f"compiled {in_path} -> {out_path} ({len(encoded)} bytes, now_epoch={now_epoch})",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
sys.exit(main(sys.argv[1:]))
|
||||
@@ -0,0 +1,41 @@
|
||||
{
|
||||
"build": {
|
||||
"arduino": {
|
||||
"ldscript": "esp32s3_out.ld",
|
||||
"memory_type": "qio_opi"
|
||||
},
|
||||
"core": "esp32",
|
||||
"extra_flags": [
|
||||
"-DBOARD_HAS_PSRAM",
|
||||
"-DARDUINO_USB_CDC_ON_BOOT=1",
|
||||
"-DARDUINO_USB_MODE=1",
|
||||
"-DARDUINO_RUNNING_CORE=1",
|
||||
"-DARDUINO_EVENT_RUNNING_CORE=0"
|
||||
],
|
||||
"f_cpu": "240000000L",
|
||||
"f_flash": "80000000L",
|
||||
"flash_mode": "qio",
|
||||
"hwids": [["0x303A", "0x1001"]],
|
||||
"mcu": "esp32s3",
|
||||
"variant": "station-g3"
|
||||
},
|
||||
"connectivity": ["wifi", "bluetooth", "lora"],
|
||||
"debug": {
|
||||
"default_tool": "esp-builtin",
|
||||
"onboard_tools": ["esp-builtin"],
|
||||
"openocd_target": "esp32s3.cfg"
|
||||
},
|
||||
"frameworks": ["arduino", "espidf"],
|
||||
"name": "BQ Station G3",
|
||||
"upload": {
|
||||
"flash_size": "16MB",
|
||||
"maximum_ram_size": 327680,
|
||||
"maximum_size": 16777216,
|
||||
"use_1200bps_touch": true,
|
||||
"wait_for_upload_port": true,
|
||||
"require_upload_port": true,
|
||||
"speed": 921600
|
||||
},
|
||||
"url": "",
|
||||
"vendor": "BQ Consulting"
|
||||
}
|
||||
@@ -82,5 +82,18 @@ if esp32_kind == "esp32":
|
||||
]
|
||||
)
|
||||
else:
|
||||
# For newer ESP32 targets, using newlib nano works better.
|
||||
env.Append(LINKFLAGS=["--specs=nano.specs", "-u", "_printf_float"])
|
||||
# For newer ESP32 targets, using newlib nano works better. Skip on
|
||||
# variants that explicitly opt out — the IDF 5.1 framework override the
|
||||
# HaLow variant uses already includes nano.specs, so re-adding it triggers
|
||||
# a duplicate spec definition error at link time.
|
||||
cppdefines = env.get("CPPDEFINES", [])
|
||||
if not any(
|
||||
(isinstance(d, str) and d == "MESHTASTIC_SKIP_NANO_SPECS")
|
||||
or (
|
||||
isinstance(d, (list, tuple))
|
||||
and len(d) > 0
|
||||
and d[0] == "MESHTASTIC_SKIP_NANO_SPECS"
|
||||
)
|
||||
for d in cppdefines
|
||||
):
|
||||
env.Append(LINKFLAGS=["--specs=nano.specs", "-u", "_printf_float"])
|
||||
|
||||
@@ -0,0 +1,28 @@
|
||||
"""
|
||||
PlatformIO doesn't natively link .o files vendored inside a library directory.
|
||||
The Morse Micro SDK ships the chip firmware (mm6108.mbin.o) and per-region BCF
|
||||
(bcf_mf08651_us.mbin.o) as pre-built object files containing data sections.
|
||||
This script appends them to LINKFLAGS so they land in the final ELF.
|
||||
|
||||
US region only for now — when we add EU/JP/KR variants, gate the BCF here on a
|
||||
build flag and pick the matching .o file.
|
||||
"""
|
||||
|
||||
import os
|
||||
|
||||
Import("env", "projenv")
|
||||
|
||||
LIB_DIR = os.path.join(env.subst("$PROJECT_DIR"), "lib", "MorseWlan")
|
||||
|
||||
mbin_objects = [
|
||||
os.path.join(LIB_DIR, "src", "mm6108.mbin.o"),
|
||||
os.path.join(LIB_DIR, "src", "bcf_mf08651_us.mbin.o"),
|
||||
]
|
||||
|
||||
# Only add objects that actually exist; missing ones surface as link errors,
|
||||
# not silent corruption.
|
||||
for obj in mbin_objects:
|
||||
if not os.path.isfile(obj):
|
||||
print("warning: mm-iot-esp32 blob missing: %s" % obj)
|
||||
|
||||
env.Append(LINKFLAGS=mbin_objects)
|
||||
@@ -0,0 +1,77 @@
|
||||
/*
|
||||
* Copyright 2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MBIN Morse BINary Loader API
|
||||
*
|
||||
* This file defines the structure of the @c MBIN file.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifndef PACKED
|
||||
/** Macro for the compiler packed attribute */
|
||||
#define PACKED __attribute__((packed))
|
||||
#endif
|
||||
|
||||
/** Enumeration of TLV field types */
|
||||
enum mbin_tlv_types {
|
||||
FIELD_TYPE_FW_TLV_BCF_ADDR = 0x0001,
|
||||
FIELD_TYPE_MAGIC = 0x8000,
|
||||
FIELD_TYPE_FW_SEGMENT = 0x8001,
|
||||
FIELD_TYPE_FW_SEGMENT_DEFLATED = 0x8002,
|
||||
FIELD_TYPE_BCF_BOARD_CONFIG = 0x8100,
|
||||
FIELD_TYPE_BCF_REGDOM = 0x8101,
|
||||
FIELD_TYPE_BCF_BOARD_DESC = 0x8102,
|
||||
FIELD_TYPE_BCF_BUILD_VER = 0x8103,
|
||||
FIELD_TYPE_SW_SEGMENT = 0x8201,
|
||||
FIELD_TYPE_SW_SEGMENT_DEFLATED = 0x8202,
|
||||
FIELD_TYPE_EOF = 0x8f00,
|
||||
FIELD_TYPE_EOF_WITH_SIGNATURE = 0x8f01,
|
||||
};
|
||||
|
||||
/** TLV header data structure. */
|
||||
struct PACKED mbin_tlv_hdr {
|
||||
/** Type (see mbin_tlv_types). */
|
||||
uint16_t type;
|
||||
/** Length of payload (excludes header). */
|
||||
uint16_t len;
|
||||
};
|
||||
|
||||
/** Data header in a FIELD_TYPE_XX_SEGMENT field. */
|
||||
struct PACKED mbin_segment_hdr {
|
||||
/** Destination base address at which the data should be loaded. */
|
||||
uint32_t base_address;
|
||||
};
|
||||
|
||||
/** Data header in a FIELD_TYPE_XX_SEGMENT_DEFLATED field. */
|
||||
struct PACKED mbin_deflated_segment_hdr {
|
||||
/** Destination base address at which the data should be loaded. */
|
||||
uint32_t base_address;
|
||||
/** Size of deflated data, infer size of compressed data from TLV length */
|
||||
uint16_t chunk_size;
|
||||
/** ZLib header */
|
||||
uint8_t zlib_header[2];
|
||||
};
|
||||
|
||||
/** Data header in a @c FIELD_TYPE_BCF_REGDOM field. */
|
||||
struct PACKED mbin_regdom_hdr {
|
||||
/** Country code that this @c regdom applies to. */
|
||||
uint8_t country_code[2];
|
||||
/** Reserved */
|
||||
uint16_t reserved;
|
||||
};
|
||||
|
||||
/** Expected value of the magic field for a SW image @c MMSW. */
|
||||
#define MBIN_SW_MAGIC_NUMBER (0x57534d4d)
|
||||
/** Expected value of the magic field for a firmware image @c MMFW. */
|
||||
#define MBIN_FW_MAGIC_NUMBER (0x57464d4d)
|
||||
/** Expected value of the magic field for a BCF @c MMBC. */
|
||||
#define MBIN_BCF_MAGIC_NUMBER (0x43424d4d)
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,124 @@
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/*
|
||||
* This file should be included from the application mbedtls_config.h file to ensure that
|
||||
* the mbedTLS features necessary for morselib functionality are enabled.
|
||||
*
|
||||
* It is recommended to include this file at the _end_ of the application mbedtls_config.h file
|
||||
* to avoid redefinition of macros.
|
||||
*/
|
||||
|
||||
/* Cipher modes */
|
||||
#ifndef MBEDTLS_CIPHER_MODE_CBC
|
||||
#define MBEDTLS_CIPHER_MODE_CBC
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_CIPHER_MODE_CTR
|
||||
#define MBEDTLS_CIPHER_MODE_CTR
|
||||
#endif
|
||||
|
||||
/* EC curves */
|
||||
#ifndef MBEDTLS_ECP_DP_SECP256R1_ENABLED
|
||||
#define MBEDTLS_ECP_DP_SECP256R1_ENABLED
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ECP_DP_SECP384R1_ENABLED
|
||||
#define MBEDTLS_ECP_DP_SECP384R1_ENABLED
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ECP_DP_SECP521R1_ENABLED
|
||||
#define MBEDTLS_ECP_DP_SECP521R1_ENABLED
|
||||
#endif
|
||||
|
||||
/* Features */
|
||||
#ifndef MBEDTLS_AES_C
|
||||
#define MBEDTLS_AES_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ASN1_PARSE_C
|
||||
#define MBEDTLS_ASN1_PARSE_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ASN1_WRITE_C
|
||||
#define MBEDTLS_ASN1_WRITE_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_BIGNUM_C
|
||||
#define MBEDTLS_BIGNUM_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_CIPHER_C
|
||||
#define MBEDTLS_CIPHER_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_CMAC_C
|
||||
#define MBEDTLS_CMAC_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_CTR_DRBG_C
|
||||
#define MBEDTLS_CTR_DRBG_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ECDH_C
|
||||
#define MBEDTLS_ECDH_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ECP_C
|
||||
#define MBEDTLS_ECP_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_ENTROPY_C
|
||||
#define MBEDTLS_ENTROPY_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_MD_C
|
||||
#define MBEDTLS_MD_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_NIST_KW_C
|
||||
#define MBEDTLS_NIST_KW_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_OID_C
|
||||
#define MBEDTLS_OID_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_PK_C
|
||||
#define MBEDTLS_PK_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_PK_PARSE_C
|
||||
#define MBEDTLS_PK_PARSE_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_PK_WRITE_C
|
||||
#define MBEDTLS_PK_WRITE_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_PKCS5_C
|
||||
#define MBEDTLS_PKCS5_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_SHA1_C
|
||||
#define MBEDTLS_SHA1_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_SHA224_C
|
||||
#define MBEDTLS_SHA224_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_SHA256_C
|
||||
#define MBEDTLS_SHA256_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_SHA384_C
|
||||
#define MBEDTLS_SHA384_C
|
||||
#endif
|
||||
|
||||
#ifndef MBEDTLS_SHA512_C
|
||||
#define MBEDTLS_SHA512_C
|
||||
#endif
|
||||
@@ -0,0 +1,331 @@
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMHAL Morse Micro Hardware Abstraction Layer (mmhal) API
|
||||
*
|
||||
* This API provides abstraction from the underlying hardware/BSP.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "mmhal_flash.h"
|
||||
#include "mmhal_wlan.h"
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
#include <time.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** Initialization before RTOS scheduler starts. */
|
||||
void mmhal_early_init(void);
|
||||
|
||||
/** Initialization after RTOS scheduler started. */
|
||||
void mmhal_init(void);
|
||||
|
||||
/** Enumeration of ISR states (i.e., whether in ISR or not). */
|
||||
enum mmhal_isr_state {
|
||||
MMHAL_NOT_IN_ISR, /**< The function was not executed from ISR context. */
|
||||
MMHAL_IN_ISR, /**< The function was executed from ISR context. */
|
||||
MMHAL_ISR_STATE_UNKNOWN, /**< The HAL does not support checking ISR state. */
|
||||
};
|
||||
|
||||
/**
|
||||
* Enumeration for different LED's on the board.
|
||||
*
|
||||
* @note Some of these LED's may not be available on all boards and some of these values
|
||||
* may refer to the same LED.
|
||||
*/
|
||||
enum mmhal_led_id { LED_RED, LED_GREEN, LED_BLUE, LED_WHITE };
|
||||
|
||||
/** Enumeration of MCU sleep state. */
|
||||
enum mmhal_sleep_state {
|
||||
MMHAL_SLEEP_DISABLED, /**< Disable MCU sleep. */
|
||||
MMHAL_SLEEP_SHALLOW, /**< MCU to enter shallow sleep. */
|
||||
MMHAL_SLEEP_DEEP, /**< MCU can enter deep sleep. */
|
||||
};
|
||||
|
||||
/** A value of 0 turns OFF an LED */
|
||||
#define LED_OFF 0
|
||||
|
||||
/**
|
||||
* A value of 255 turns an LED ON fully.
|
||||
*
|
||||
* Some boards support varying an LED's brightness. For these boards a value between 1 and 255
|
||||
* will result in proportionately varying levels of brightness. LED's that do not have a
|
||||
* brightness control feature will just turn ON fully for any non zero value.
|
||||
*/
|
||||
#define LED_ON 255
|
||||
|
||||
/**
|
||||
* Get the current ISR state (i.e., whether in ISR or not).
|
||||
*
|
||||
* @returns the current ISR state, or @c MMHAL_ISR_STATE_UNKNOWN if the HAL does not support
|
||||
* checking ISR state.
|
||||
*/
|
||||
enum mmhal_isr_state mmhal_get_isr_state(void);
|
||||
|
||||
/**
|
||||
* Write to the debug log.
|
||||
*
|
||||
* It is assumed the caller will have mechanisms in place to prevent concurrent access.
|
||||
*
|
||||
* @param data Buffer containing data to write.
|
||||
* @param len Length of data in buffer.
|
||||
*/
|
||||
void mmhal_log_write(const uint8_t *data, size_t len);
|
||||
|
||||
/**
|
||||
* Flush the debug log before returning.
|
||||
*
|
||||
* @warning Implementations of this function must support being invoked with interrupts disabled.
|
||||
*/
|
||||
void mmhal_log_flush(void);
|
||||
|
||||
/**
|
||||
* Generate a random 32 bit integer within the given range.
|
||||
*
|
||||
* @param min Minimum value (inclusive).
|
||||
* @param max Maximum value (inclusive).
|
||||
*
|
||||
* @returns a randomly generated integer (min <= i <= max).
|
||||
*/
|
||||
uint32_t mmhal_random_u32(uint32_t min, uint32_t max);
|
||||
|
||||
/** Reset the microcontroller. */
|
||||
void mmhal_reset(void);
|
||||
|
||||
/**
|
||||
* Set the specified LED to the requested level. Do nothing if the requested LED does not exist.
|
||||
*
|
||||
* @param led The LED to set, if the platform supports it. See @ref mmhal_led_id
|
||||
* @param level The level to set it to. 0 means OFF and non-zero means ON. If the platform supports
|
||||
* brightness levels then 255 is full. Defines @ref LED_ON and @ref LED_OFF are
|
||||
* provided for ease of use.
|
||||
*/
|
||||
void mmhal_set_led(uint8_t led, uint8_t level);
|
||||
|
||||
/**
|
||||
* Set the error LED to the requested state.
|
||||
*
|
||||
* @note This function is called by the bootloader and so needs to do all the initialization
|
||||
* required to set the LED's as the bootloader does not use the regular BSP initialization
|
||||
* located in main.c for configuring @c GPIO's and setting clock gates as required.
|
||||
*
|
||||
* @param state Set to true if the LED needs to be turned on,
|
||||
* or false if the led needs to be turned off.
|
||||
*/
|
||||
void mmhal_set_error_led(bool state);
|
||||
|
||||
/**
|
||||
* Enumeration for buttons on the board.
|
||||
*
|
||||
* @note The support for each button is platform dependent.
|
||||
*/
|
||||
enum mmhal_button_id { BUTTON_ID_USER0 };
|
||||
|
||||
/**
|
||||
* Enumeration for button states
|
||||
*/
|
||||
enum mmhal_button_state { BUTTON_RELEASED, BUTTON_PRESSED };
|
||||
|
||||
/** Button state callback function prototype. */
|
||||
typedef void (*mmhal_button_state_cb_t)(enum mmhal_button_id button_id, enum mmhal_button_state button_state);
|
||||
|
||||
/**
|
||||
* Registers a callback handler for button state changes.
|
||||
*
|
||||
* @note The callback will be executed in an Interrupt Service Routine context
|
||||
*
|
||||
* @param button_id The button whose state should be reported to the callback
|
||||
* @param button_state_cb The function to call on button state change, or NULL to disable.
|
||||
* @returns True if the callback is registered successfully, False if not supported
|
||||
*/
|
||||
bool mmhal_set_button_callback(enum mmhal_button_id button_id, mmhal_button_state_cb_t button_state_cb);
|
||||
|
||||
/**
|
||||
* Returns the registered callback handler for button state changes.
|
||||
*
|
||||
* @param button_id The button whose callback should be returned
|
||||
* @returns The registered callback or NULL if no callback registered
|
||||
*/
|
||||
mmhal_button_state_cb_t mmhal_get_button_callback(enum mmhal_button_id button_id);
|
||||
|
||||
/**
|
||||
* Reads the state of the specified button.
|
||||
*
|
||||
* @param button_id The button state to read
|
||||
* @returns The current button state, or BUTTON_RELEASED if not supported
|
||||
*/
|
||||
enum mmhal_button_state mmhal_get_button(enum mmhal_button_id button_id);
|
||||
|
||||
/**
|
||||
* Reads information that can be used to identify the hardware platform, such as
|
||||
* hardware ID and version number, in the form of a user readable string.
|
||||
*
|
||||
* This function attempts to detect the correct hardware and version.
|
||||
* The actual means of detecting the correct hardware and version will vary from
|
||||
* implementation to implementation and may use means such as identification
|
||||
* information stored in EEPROM or devices detected on GPIO, SPI or I2C interfaces.
|
||||
* Returns false if the hardware could not be identified correctly.
|
||||
*
|
||||
* @param version_buffer The pre-allocated buffer to return the hardware ID and version in.
|
||||
* @param version_buffer_length The length of the pre-allocated buffer.
|
||||
* @returns True if the hardware was correctly identified and returned.
|
||||
*/
|
||||
bool mmhal_get_hardware_version(char *version_buffer, size_t version_buffer_length);
|
||||
|
||||
/**
|
||||
* Macro to simplify debug pin mask/value definition.
|
||||
*
|
||||
* @param _pin_num The pin number to set in the mask. Must be 0-31 (inclusive).
|
||||
*
|
||||
* Example:
|
||||
*
|
||||
* mmhal_set_debug_pins(MMHAL_DEBUG_PIN(0), MMHAL_DEBUG_PIN(0));
|
||||
*/
|
||||
#define MMHAL_DEBUG_PIN(_pin_num) (1ul << (_pin_num))
|
||||
|
||||
/** Bit mask with all debug pins selected. */
|
||||
#define MMHAL_ALL_DEBUG_PINS (UINT32_MAX)
|
||||
|
||||
/**
|
||||
* Set the value one or more debug pins.
|
||||
*
|
||||
* Each platform can define up to 32 GPIOs for application use. If a GPIO is not supported
|
||||
* by a platform then attempts to set it will be silently ignored. These GPIOs are intended
|
||||
* for debug/test purposes.
|
||||
*
|
||||
* @param mask Mask of GPIOs to modify. Each bit in this mask that is set will result in
|
||||
* the corresponding GPIO being being set to the corresponding value given in
|
||||
* @p values.
|
||||
* @param values Bit field, where each bit corresponds to a GPIO, specifying the direction
|
||||
* to drive each GPIO with 1 meaning drive high and 0 meaning drive low.
|
||||
* Only GPIOs with the corresponding bit set in @p mask will be modified.
|
||||
*
|
||||
* @sa MM_DEBUG_PIN_MASK
|
||||
*/
|
||||
void mmhal_set_debug_pins(uint32_t mask, uint32_t values);
|
||||
|
||||
/**
|
||||
* Returns the time of day as set in the RTC.
|
||||
* Time is in UTC.
|
||||
*
|
||||
* @return Epoch time (seconds since 1 Jan 1970) or 0 on failure.
|
||||
*/
|
||||
time_t mmhal_get_time();
|
||||
|
||||
/**
|
||||
* Sets the RTC to the specified time in UTC.
|
||||
*
|
||||
* @note While Unix epoch time supports years from 1970, most Real Time Clock
|
||||
* chips support years from 2000 only as they store the year as years
|
||||
* from 2000. So do not attempt to set any years below 2000 as this could cause
|
||||
* the year to wrap around to an unreasonably high value. Definitely do not do:
|
||||
* @code
|
||||
* mmhal_set_time(0);
|
||||
* @endcode
|
||||
*
|
||||
* @param epoch Time in Unix epoch time (seconds since 1 Jan 1970).
|
||||
*/
|
||||
void mmhal_set_time(time_t epoch);
|
||||
|
||||
/**
|
||||
* Function to prepare MCU to enter sleep.
|
||||
* This will halt the timer that generates the RTOS tick.
|
||||
*
|
||||
* @param expected_idle_time_ms Expected time to sleep in milliseconds.
|
||||
*
|
||||
* @returns the type of sleep permitted by the current system state.
|
||||
*/
|
||||
enum mmhal_sleep_state mmhal_sleep_prepare(uint32_t expected_idle_time_ms);
|
||||
|
||||
/**
|
||||
* Function to enter MCU sleep.
|
||||
*
|
||||
* @param sleep_state Sleep state to enter into.
|
||||
* @param expected_idle_time_ms Expected time to sleep in milliseconds.
|
||||
*
|
||||
* @returns Elapsed sleep time in milliseconds.
|
||||
*/
|
||||
uint32_t mmhal_sleep(enum mmhal_sleep_state sleep_state, uint32_t expected_idle_time_ms);
|
||||
|
||||
/**
|
||||
* Function to abort the MCU sleep state.
|
||||
*
|
||||
* @note This must only be invoked after @ref mmhal_sleep_prepare()
|
||||
* and before @ref mmhal_sleep().
|
||||
*
|
||||
* @param sleep_state Sleep state to abort.
|
||||
*/
|
||||
void mmhal_sleep_abort(enum mmhal_sleep_state sleep_state);
|
||||
|
||||
/**
|
||||
* Function to cleanup on exit from the MCU sleep state.
|
||||
*/
|
||||
void mmhal_sleep_cleanup(void);
|
||||
|
||||
/** Enumeration of veto_id ranges for use with @ref mmhal_set_deep_sleep_veto() and
|
||||
* @ref mmhal_clear_deep_sleep_veto(). */
|
||||
enum mmhal_veto_id {
|
||||
/** Start of deep sleep veto ID range that is available for application use. */
|
||||
MMHAL_VETO_ID_APP_MIN = 0,
|
||||
/** End of deep sleep veto ID range that is available for application use. */
|
||||
MMHAL_VETO_ID_APP_MAX = 7,
|
||||
/** Start of deep sleep veto ID range that is available for HAL use. */
|
||||
MMHAL_VETO_ID_HAL_MIN = 8,
|
||||
/** End of deep sleep veto ID range that is available for HAL use. */
|
||||
MMHAL_VETO_ID_HAL_MAX = 15,
|
||||
/** Start of deep sleep veto ID range that is allocated for morselib use. Note that this
|
||||
* must not be changed as it is built into morselib. */
|
||||
MMHAL_VETO_ID_MORSELIB_MIN = 16,
|
||||
/** End of deep sleep veto ID range that is allocated for morselib use. Note that this must not
|
||||
* be changed as it is built into morselib. */
|
||||
MMHAL_VETO_ID_MORSELIB_MAX = 19,
|
||||
/** Deep sleep veto ID for data-link subsystem. */
|
||||
MMHAL_VETO_ID_DATALINK = 20,
|
||||
/** Deep sleep veto ID allocated to @ref MMCONFIG. */
|
||||
MMHAL_VETO_ID_MMCONFIG = 21,
|
||||
/** Start of deep sleep veto ID range reserved for future use. */
|
||||
MMHAL_VETO_ID_RESERVED_MIN = 22,
|
||||
/** End of deep sleep veto ID range reserved for future use. */
|
||||
MMHAL_VETO_ID_RESERVED_MAX = 31,
|
||||
};
|
||||
|
||||
/**
|
||||
* Sets a deep sleep veto that will prevent the device from entering deep sleep. The device
|
||||
* will not enter deep sleep until there are no vetoes remaining. This veto can be cleared
|
||||
* by a call to @ref mmhal_clear_deep_sleep_veto() with the same veto_id.
|
||||
*
|
||||
* Up to 32 vetoes are supported (ID numbers 0-31). Each veto should be used exclusively by
|
||||
* a given aspect of the system (e.g., to prevent deep sleep when a DMA transfer is in progress,
|
||||
* or to prevent deep sleep when there is log data buffered for transmit, etc.).
|
||||
*
|
||||
* @param veto_id The veto identifier. Valid values are 0-31, and these are split up into ranges
|
||||
* for use by different subsystems -- see @ref mmhal_veto_id.
|
||||
*/
|
||||
void mmhal_set_deep_sleep_veto(uint8_t veto_id);
|
||||
|
||||
/**
|
||||
* Clears a deep sleep veto that was preventing the device from entering deep sleep (see
|
||||
* @ref mmhal_set_deep_sleep_veto()). If the given veto was not already set then this has
|
||||
* no effect.
|
||||
*
|
||||
* @param veto_id The veto identifier. Valid values are 0-31, and these are split up into ranges
|
||||
* for use by different subsystems -- see @ref mmhal_veto_id.
|
||||
*/
|
||||
void mmhal_clear_deep_sleep_veto(uint8_t veto_id);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,145 @@
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup MMHAL Morse Micro Flash Hardware Abstraction Layer (mmhal_flash) API
|
||||
*
|
||||
* This API provides abstraction from the underlying flash hardware/.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* This is the value erased flash bytes are set to. This shall be @c 0xFF as this is the
|
||||
* value that hardware flash erases to.
|
||||
*/
|
||||
#define MMHAL_FLASH_ERASE_VALUE 0xFF
|
||||
|
||||
/** LittleFS configuration structure. Include @c lfs.h for definition. */
|
||||
struct lfs_config;
|
||||
|
||||
/**
|
||||
* Flash partition configuration structure
|
||||
*
|
||||
* This should be initialized using @c MMHAL_FLASH_PARTITION_CONFIG_DEFAULT.
|
||||
* For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* struct mmhal_flash_partition_config partition = MMHAL_FLASH_PARTITION_CONFIG_DEFAULT;
|
||||
* @endcode
|
||||
*/
|
||||
struct mmhal_flash_partition_config {
|
||||
/** The start address of the partition, this may be a physical address
|
||||
* or a relative address depending on implementation
|
||||
*/
|
||||
uint32_t partition_start;
|
||||
|
||||
/** The size of the partition */
|
||||
uint32_t partition_size;
|
||||
|
||||
/**
|
||||
* If true, then the partition is not memory mapped and cannot be directly accessed
|
||||
* at the physical @c partition_start address
|
||||
*/
|
||||
bool not_memory_mapped;
|
||||
};
|
||||
|
||||
/** Initial values for @ref mmhal_flash_partition_config. */
|
||||
#define MMHAL_FLASH_PARTITION_CONFIG_DEFAULT \
|
||||
{ \
|
||||
0, 0, false \
|
||||
}
|
||||
|
||||
/**
|
||||
* Get MMCONFIG flash partition configuration.
|
||||
*
|
||||
* MMCONFIG initialization is done by @c mmconfig_init() in @c mmconfig.c.
|
||||
* which in turn calls this function to fetch the partition configuration for config store
|
||||
* from the HAL layer. If config store is not supported by the platform then we just
|
||||
* return NULL. This function returns a static pointer to
|
||||
* @c struct @c mmhal_flash_partition_config.
|
||||
*
|
||||
* @return A static pointer to the partition config for MMCONFIG, or NULL if not supported.
|
||||
*/
|
||||
const struct mmhal_flash_partition_config *mmhal_get_mmconfig_partition(void);
|
||||
|
||||
/**
|
||||
* Erases a block of Flash pointed to by the block_address.
|
||||
*
|
||||
* The block address may be anywhere within the block to erase. The entire block gets erased.
|
||||
* Once erased all bytes in the block shall be @c MMHAL_FLASH_ERASE_VALUE (@c 0xFF).
|
||||
*
|
||||
* @param block_address The address of the block of Flash to erase.
|
||||
* @return 0 on success, negative number on failure
|
||||
*/
|
||||
int mmhal_flash_erase(uint32_t block_address);
|
||||
|
||||
/**
|
||||
* Returns the size of the Flash block at the specified address.
|
||||
*
|
||||
* @param block_address The address of the Flash block.
|
||||
* @return The size of the Flash block in bytes.
|
||||
* Returns 0 if an invalid address is specified.
|
||||
*/
|
||||
uint32_t mmhal_flash_getblocksize(uint32_t block_address);
|
||||
|
||||
/**
|
||||
* Read a block of data from the specified Flash address into the buffer.
|
||||
*
|
||||
* @param read_address The address in Flash to read from.
|
||||
* @param buf The buffer to read into.
|
||||
* @param size The number of bytes to read.
|
||||
* @return 0 on success, or a negative number on failure.
|
||||
*/
|
||||
int mmhal_flash_read(uint32_t read_address, uint8_t *buf, size_t size);
|
||||
|
||||
/**
|
||||
* Write a block of data to the specified Flash address.
|
||||
*
|
||||
* There is no alignment or minimum size requirement. This function will
|
||||
* take care of aligning the data and merging with existing Flash contents.
|
||||
* The Flash block is not erased, it is up to the application to determine
|
||||
* if the block needs to be erased before programming.
|
||||
*
|
||||
* @param write_address The address in Flash to write to.
|
||||
* @param data A pointer to the block of data to write.
|
||||
* @param size The number of bytes to write.
|
||||
* @return 0 on success, or a negative number on failure.
|
||||
*/
|
||||
int mmhal_flash_write(uint32_t write_address, const uint8_t *data, size_t size);
|
||||
|
||||
/**
|
||||
* Get LittleFS configuration.
|
||||
*
|
||||
* LittleFS initialization is done by @c littlefs_init() in @c mmosal_shim_fileio.c.
|
||||
* which in turn calls this function to fetch the hardware configuration for LittleFS
|
||||
* from the HAL layer. The LittleFS configuration will vary from platform to platform.
|
||||
* If LittleFS is not supported by the platform then we just return NULL. This function
|
||||
* returns a static pointer to @c struct @c lfs_config which is defined in @c lfs.h.
|
||||
*
|
||||
* See @c mmhal_littlefs.c for the full HAL layer implementation for your platform.
|
||||
* See @c mmosal_shim_fileio.c for the @c libc shims for LittleFS.
|
||||
* See @c README.md in the @c src/littlefs folder for detailed information on LittleFS.
|
||||
*
|
||||
* @return A static pointer to the LittleFS config structure, or NULL if not supported.
|
||||
*/
|
||||
const struct lfs_config *mmhal_get_littlefs_config(void);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,89 @@
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup MMHAL
|
||||
* @defgroup MMHAL_UART Morse Micro Abstraction Layer API for UART
|
||||
*
|
||||
* This provides an abstraction layer for a UART. This is used by MM-IoT-SDK example
|
||||
* applications.
|
||||
*
|
||||
* This is a very simple API and leaves UART configuration to the HAL.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "mmhal.h"
|
||||
#include "mmosal.h"
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Function type for UART RX callback.
|
||||
*
|
||||
* @note The UART HAL must not invoke this function from interrupt context. However, the
|
||||
* implementation should not block for long periods of time or received data may be lost.
|
||||
*
|
||||
* @param data The received data.
|
||||
* @param length Length of the received data.
|
||||
* @param arg Opaque argument (as passed in to @ref mmhal_uart_init()).
|
||||
*/
|
||||
typedef void (*mmhal_uart_rx_cb_t)(const uint8_t *data, size_t length, void *arg);
|
||||
|
||||
/**
|
||||
* Initialize the UART HAL and perform any setup necessary.
|
||||
*
|
||||
* @param rx_cb Optional callback to be invoked on receive (may be NULL).
|
||||
* This callback may be invoked from interrupt context so should return
|
||||
* quickly.
|
||||
* @param rx_cb_arg Optional opaque argument to be passed to the RX callback. May be NULL.
|
||||
*/
|
||||
void mmhal_uart_init(mmhal_uart_rx_cb_t rx_cb, void *rx_cb_arg);
|
||||
|
||||
/**
|
||||
* Deinitialize the UART HAL, and disable the UART.
|
||||
*/
|
||||
void mmhal_uart_deinit(void);
|
||||
|
||||
/**
|
||||
* Transmit data on the UART. This will block until all data is buffered for transmit (but may
|
||||
* return before transmission has completed).
|
||||
*
|
||||
* @param data Data to transmit.
|
||||
* @param length Length of @p data.
|
||||
*/
|
||||
void mmhal_uart_tx(const uint8_t *data, size_t length);
|
||||
|
||||
/** Enumeration of deep sleep modes for the UART HAL. */
|
||||
enum mmhal_uart_deep_sleep_mode {
|
||||
/** Deep sleep mode is disabled. */
|
||||
MMHAL_UART_DEEP_SLEEP_DISABLED,
|
||||
/** Enable deep sleep until activity occurs on data-link transport. */
|
||||
MMHAL_UART_DEEP_SLEEP_ONE_SHOT,
|
||||
};
|
||||
|
||||
/**
|
||||
* Set the deep sleep mode for the UART. See @ref mmhal_uart_deep_sleep_mode for possible deep
|
||||
* sleep modes. Note that a given platform may not support all modes.
|
||||
*
|
||||
* @param mode The deep sleep mode to set.
|
||||
*
|
||||
* @returns true if the mode was set successfully; false on failure (e.g., unsupported mode).
|
||||
*/
|
||||
bool mmhal_uart_set_deep_sleep_mode(enum mmhal_uart_deep_sleep_mode mode);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,640 @@
|
||||
/*
|
||||
* Copyright 2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup MMHAL
|
||||
* @defgroup MMHAL_WLAN WLAN HAL
|
||||
*
|
||||
* API for communicating with the WLAN transceiver.
|
||||
*
|
||||
* There are different interfaces supported for communicating with the transceiver:
|
||||
*
|
||||
* * @ref MMHAL_WLAN_SDIO
|
||||
* * @ref MMHAL_WLAN_SPI
|
||||
*
|
||||
* @warning These functions shall not be called directly by the end application they are for use
|
||||
* by Morselib.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "mmpkt.h"
|
||||
#include "mmwlan.h"
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
#include <time.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Function prototype for interrupt handler callbacks.
|
||||
*/
|
||||
typedef void (*mmhal_irq_handler_t)(void);
|
||||
|
||||
/**
|
||||
* Initialize the WLAN HAL.
|
||||
*
|
||||
* Things to do here may include:
|
||||
* * Enable SPI peripheral
|
||||
* * Configure GPIOs
|
||||
* * Enable power to the Morse Micro transceiver
|
||||
*
|
||||
* @note If enabling power for the Morse Micro transceiver in this function you may need to add a
|
||||
* blocking delay to allow the power rail to stabilize. This is hardware specific so is not
|
||||
* accounted for in the calling function.
|
||||
*/
|
||||
void mmhal_wlan_init(void);
|
||||
|
||||
/**
|
||||
* Deinitialize the WLAN HAL.
|
||||
*
|
||||
* Things to do here may include:
|
||||
* * Disable SPI peripheral
|
||||
* * Disable GPIOs
|
||||
* * Disable power to the Morse Micro transceiver
|
||||
*/
|
||||
void mmhal_wlan_deinit(void);
|
||||
|
||||
/**
|
||||
* Get MAC address override.
|
||||
*
|
||||
* This function allows the HAL to override the MAC address to be used by the device. The
|
||||
* MAC address override should be written to @p mac_addr. If no override is required then
|
||||
* @p mac_addr should be left untouched.
|
||||
*
|
||||
* @param[out] mac_addr Location where the MAC address will be stored. This will be initialized
|
||||
* to zero the first time this function is invoked, and to the previously
|
||||
* configured MAC address on subsequent invocations.
|
||||
*/
|
||||
void mmhal_read_mac_addr(uint8_t *mac_addr);
|
||||
|
||||
/**
|
||||
* Assert the WLAN wake pin.
|
||||
*/
|
||||
void mmhal_wlan_wake_assert(void);
|
||||
|
||||
/**
|
||||
* Deassert the WLAN wake pin.
|
||||
*/
|
||||
void mmhal_wlan_wake_deassert(void);
|
||||
|
||||
/**
|
||||
* Tests whether the busy pin is currently asserted.
|
||||
*
|
||||
* @note This is whether it is logically asserted and does not necessarily
|
||||
* represent the level of the GPIO pin.
|
||||
*
|
||||
* @returns @c true if asserted, else @c false.
|
||||
*/
|
||||
bool mmhal_wlan_busy_is_asserted(void);
|
||||
|
||||
/**
|
||||
* Register a handler for busy interrupts.
|
||||
*
|
||||
* @param handler The handler to register.
|
||||
*/
|
||||
void mmhal_wlan_register_busy_irq_handler(mmhal_irq_handler_t handler);
|
||||
|
||||
/**
|
||||
* Sets whether the busy interrupt is enabled.
|
||||
*
|
||||
* @warning The interrupt handler function must be configured using
|
||||
* mmhal_wlan_register_busy_irq_handler() before enabling the interrupt.
|
||||
*
|
||||
* @param enabled @c true to enable or @c false to disable.
|
||||
*/
|
||||
void mmhal_wlan_set_busy_irq_enabled(bool enabled);
|
||||
|
||||
/**
|
||||
* Read-only buffer data structure.
|
||||
*
|
||||
* The design of this data structure allows the buffer to exist either in statically or
|
||||
* dynamically allocated memory.
|
||||
*
|
||||
* For statically allocated memory, the field @c free_cb may be set to @c NULL and @c free_arg
|
||||
* ignored. For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* const uint8_t some_data[] = { 0x00, 0x01, 0x02 };
|
||||
*
|
||||
* void put_some_data_into_buf(struct mmhal_robuf *robuf)
|
||||
* {
|
||||
* robuf->buf = some_data;
|
||||
* robuf->len = sizeof(some_data);
|
||||
* robuf->free_cb = NULL;
|
||||
* }
|
||||
* @endcode
|
||||
*
|
||||
* For dynamically allocated memory, the field @c free_cb is set to the appropriate function to
|
||||
* free the buffer and @c free_arg is an opaque argument to the free function. This approach might
|
||||
* be used, for example, when reading into a temporary buffer from storage that is not memory
|
||||
* mapped. For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* #define SOME_DATA_MAXLEN (64)
|
||||
*
|
||||
* void put_some_data_into_buf(struct mmhal_robuf *robuf)
|
||||
* {
|
||||
* uint8_t *buf = malloc(SOME_DATA_MAXLEN);
|
||||
* robuf->buf = buf;
|
||||
* if (robuf->buf == NULL)
|
||||
* return;
|
||||
*
|
||||
* // HERE: copy data into buf and set robuf->len as appropriate
|
||||
*
|
||||
* robuf->free_cb = free;
|
||||
* robuf->free_arg = buf;
|
||||
* }
|
||||
* @endcode
|
||||
*
|
||||
*/
|
||||
struct mmhal_robuf {
|
||||
/** Pointer to the start of the read-only buffer. May be NULL only if @c len is zero. */
|
||||
const uint8_t *buf;
|
||||
/** Length of the buffer contents. */
|
||||
uint32_t len;
|
||||
/**
|
||||
* Optional callback to be invoked by the consumer to release the buffer when it is
|
||||
* no longer required. If not required, set to @c NULL.
|
||||
*
|
||||
* @note The values of @c buf and @c len in this structure may be modified before
|
||||
* @c free_cb() is invoked. However, the value of @c free_arg will be passed
|
||||
* to @c free_cb().
|
||||
*/
|
||||
void (*free_cb)(void *arg);
|
||||
/** Optional argument to @c free_cb. Ignored if @c free_cb is @c NULL. */
|
||||
void *free_arg;
|
||||
};
|
||||
|
||||
/** Minimum length of data to be returned by @ref mmhal_wlan_read_bcf_file() and
|
||||
* @ref mmhal_wlan_read_fw_file(). */
|
||||
#define MMHAL_WLAN_FW_BCF_MIN_READ_LENGTH (4)
|
||||
|
||||
/**
|
||||
* Retrieves the content of the Morse Micro Board Configuration File and places it into the given
|
||||
* buffer.
|
||||
*
|
||||
* @param offset Offset from which to start reading the bcf
|
||||
* @param requested_len Length of data we would like to read. The length of the data returned
|
||||
* by this function may be less than @p requested_len, but must be at
|
||||
* least @ref MMHAL_WLAN_FW_BCF_MIN_READ_LENGTH.
|
||||
* @param robuf Read-only buffer data structure to be filled out by this function.
|
||||
*
|
||||
* @note On error, this function should set @c robuf->buf to @c NULL.
|
||||
* @note The caller must zero @p robuf before invoking the function.
|
||||
* @note The BCF must be in mbin format.
|
||||
*
|
||||
* @warning The caller is responsible for checking @c robuf->free_cb and calling when the buffer is
|
||||
* no longer required. Ignored if @c robuf->free_cb is @c NULL.
|
||||
*/
|
||||
void mmhal_wlan_read_bcf_file(uint32_t offset, uint32_t requested_len, struct mmhal_robuf *robuf);
|
||||
|
||||
/**
|
||||
* Retrieves the content of the Morse Micro Chip Firmware and places it into the given buffer.
|
||||
*
|
||||
* @param offset Offset from which to start reading the bcf
|
||||
* @param requested_len Length of data we would like to read. The length of the data returned
|
||||
* by this function may be less than @p requested_len, but must be at
|
||||
* least @ref MMHAL_WLAN_FW_BCF_MIN_READ_LENGTH.
|
||||
* @param robuf Read-only buffer data structure to be filled out by this function.
|
||||
*
|
||||
* @note On error, this function should set @c robuf->buf to @c NULL.
|
||||
* @note The caller must zero @p robuf before invoking the function.
|
||||
* @note The firmware must be in mbin format.
|
||||
*
|
||||
* @warning The caller is responsible for checking @c robuf->free_cb and calling when the buffer
|
||||
* is no longer required. Ignored if @c robuf->free_cb is @c NULL.
|
||||
*/
|
||||
void mmhal_wlan_read_fw_file(uint32_t offset, uint32_t requested_len, struct mmhal_robuf *robuf);
|
||||
|
||||
/**
|
||||
* @defgroup MMHAL_WLAN_SPI WLAN HAL API for SPI interface
|
||||
*
|
||||
* API for communicating with the WLAN transceiver over an SPI interface.
|
||||
*
|
||||
* @note These functions should only be implemented if using a SPI interface. They are not
|
||||
* required when using the @ref MMHAL_WLAN_SDIO.
|
||||
*
|
||||
* @warning These functions shall not be called directly by the end application they are for use
|
||||
* by Morselib.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Assert the WLAN SPI chip select pin.
|
||||
*/
|
||||
void mmhal_wlan_spi_cs_assert(void);
|
||||
|
||||
/**
|
||||
* Deassert the WLAN SPI chip select pin.
|
||||
*/
|
||||
void mmhal_wlan_spi_cs_deassert(void);
|
||||
|
||||
/**
|
||||
* Simultaneously read and write on the SPI bus.
|
||||
*
|
||||
* @param data Data to be written.
|
||||
*
|
||||
* @return the value that was read.
|
||||
*/
|
||||
uint8_t mmhal_wlan_spi_rw(uint8_t data);
|
||||
|
||||
/**
|
||||
* Receive multiple octets of data from SPI bus.
|
||||
*
|
||||
* @param buf The buffer to receive into.
|
||||
* @param len The number of octets to receive.
|
||||
*/
|
||||
void mmhal_wlan_spi_read_buf(uint8_t *buf, unsigned len);
|
||||
|
||||
/**
|
||||
* Transmit multiple octets of data to SPI bus.
|
||||
*
|
||||
* @param buf The buffer to transmit from.
|
||||
* @param len The number of octets to transmit.
|
||||
*
|
||||
* @note Blocks until transfer complete.
|
||||
*/
|
||||
void mmhal_wlan_spi_write_buf(const uint8_t *buf, unsigned len);
|
||||
|
||||
/**
|
||||
* Hard reset the chip by asserting and then releasing the reset pin.
|
||||
*
|
||||
* @warning This function must return with the chip in a fully booted state. i.e only return once
|
||||
* the reset_n line has been high for at least the boot time specified in the data sheet.
|
||||
* Failure to do so may lead to undefined behavior.
|
||||
*/
|
||||
void mmhal_wlan_hard_reset(void);
|
||||
|
||||
/**
|
||||
* Invoked by the driver to check whether the external crystal initialization sequence is required.
|
||||
*
|
||||
* Implementation of this function is optional if the external crystal initialization sequence
|
||||
* is not required. If this function is not implemented then the external crystal initialization
|
||||
* sequence will be disabled. Refer to the data sheet for your module to check if this initialization
|
||||
* is required.
|
||||
*
|
||||
* @returns true if the external crystal initialization sequence is required else false.
|
||||
*/
|
||||
bool mmhal_wlan_ext_xtal_init_is_required(void);
|
||||
|
||||
/**
|
||||
* Issue the training sequence required to put the transceiver into SPI mode.
|
||||
*/
|
||||
void mmhal_wlan_send_training_seq(void);
|
||||
|
||||
/**
|
||||
* Register a handler for SPI interrupts.
|
||||
*
|
||||
* @param handler The handler to register.
|
||||
*/
|
||||
void mmhal_wlan_register_spi_irq_handler(mmhal_irq_handler_t handler);
|
||||
|
||||
/**
|
||||
* Sets whether the SPI interrupt is enabled.
|
||||
*
|
||||
* @warning The interrupt handler function must be configured using
|
||||
* @ref mmhal_wlan_register_spi_irq_handler() before enabling the interrupt.
|
||||
*
|
||||
* @param enabled @c true to enable or @c false to disable.
|
||||
*/
|
||||
void mmhal_wlan_set_spi_irq_enabled(bool enabled);
|
||||
|
||||
/**
|
||||
* Tests whether the SPI interrupt pin is currently asserted.
|
||||
*
|
||||
* @note This is whether it is logically asserted and does not necessarily
|
||||
* represent the level of the GPIO pin.
|
||||
*
|
||||
* @returns @c true if asserted, else @c false.
|
||||
*/
|
||||
bool mmhal_wlan_spi_irq_is_asserted(void);
|
||||
|
||||
/**
|
||||
* Clear the SPI IRQ.
|
||||
*
|
||||
* @deprecated Do not invoke this function because it is deprecated and will be removed from the
|
||||
* mmhal API in a future release. This function need not be implemented as a weak
|
||||
* stub is used in morselib.
|
||||
*/
|
||||
void mmhal_wlan_clear_spi_irq(void);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup MMHAL_WLAN_PKT WLAN HAL API for packet memory allocation
|
||||
*
|
||||
* API for allocating and freeing packet memory.
|
||||
*
|
||||
* @warning These functions shall not be called directly by the end application they are for use
|
||||
* by Morselib.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/**
|
||||
* Flow control callback that can be invoked by the transmit packet memory manager to pause
|
||||
* and resume the data path in response to resource availability.
|
||||
*
|
||||
* @param state Current flow control state.
|
||||
*/
|
||||
typedef void (*mmhal_wlan_pktmem_tx_flow_control_cb_t)(enum mmwlan_tx_flow_control_state state);
|
||||
|
||||
/** Initialization arguments passed to @ref mmhal_wlan_pktmem_init(). */
|
||||
struct mmhal_wlan_pktmem_init_args {
|
||||
/** Flow control callback that can be used by the transmit packet memory manager. */
|
||||
mmhal_wlan_pktmem_tx_flow_control_cb_t tx_flow_control_cb;
|
||||
};
|
||||
|
||||
/**
|
||||
* Invoked by the driver to initialize the packet memory in the HAL.
|
||||
*
|
||||
* @param args Initialization arguments.
|
||||
*/
|
||||
void mmhal_wlan_pktmem_init(struct mmhal_wlan_pktmem_init_args *args);
|
||||
|
||||
/**
|
||||
* Invoked by the driver to deinitialize the packet memory in the HAL.
|
||||
*
|
||||
* This can free reserved memory and check for memory leaks.
|
||||
*/
|
||||
void mmhal_wlan_pktmem_deinit(void);
|
||||
|
||||
/**
|
||||
* Enumeration of packet classes used by @ref mmhal_wlan_alloc_mmpkt_for_tx().
|
||||
* These definitions must match the corresponding values in @c mmdrv_pkt_class.
|
||||
*/
|
||||
enum mmhal_wlan_pkt_class {
|
||||
MMHAL_WLAN_PKT_DATA_TID0, /**< Data TID0 */
|
||||
MMHAL_WLAN_PKT_DATA_TID1, /**< Data TID1 */
|
||||
MMHAL_WLAN_PKT_DATA_TID2, /**< Data TID2 */
|
||||
MMHAL_WLAN_PKT_DATA_TID3, /**< Data TID3 */
|
||||
MMHAL_WLAN_PKT_DATA_TID4, /**< Data TID4 */
|
||||
MMHAL_WLAN_PKT_DATA_TID5, /**< Data TID5 */
|
||||
MMHAL_WLAN_PKT_DATA_TID6, /**< Data TID6 */
|
||||
MMHAL_WLAN_PKT_DATA_TID7, /**< Data TID7 */
|
||||
MMHAL_WLAN_PKT_MANAGEMENT, /**< 802.11 Management and other important frames */
|
||||
MMHAL_WLAN_PKT_COMMAND, /**< Commands from driver to chip */
|
||||
};
|
||||
|
||||
/**
|
||||
* Allocates an mmpkt for transmission.
|
||||
*
|
||||
* When the pool of mmpkt buffers available for TX is exhausted, the HAL should pause the TX
|
||||
* path using the flow control callback that was registered when @ref mmhal_wlan_pktmem_init()
|
||||
* was invoked. Similarly, when the buffers become available again (and assuming the TX path is
|
||||
* not otherwise blocked) the driver should unpause the TX path.
|
||||
*
|
||||
* @param pkt_class The class of packet (to allow for prioritization).
|
||||
* @param space_at_start Amount of space to allocate at start of mmpkt (for prepend).
|
||||
* @param space_at_end Amount of space to allocate at end of mmpkt (for append).
|
||||
* @param metadata_length Amount of space to allocate for metadata (used internally by the
|
||||
* Morse driver).
|
||||
*
|
||||
* @returns a pointer to the allocated packet on success or @c NULL on allocation failure.
|
||||
*/
|
||||
struct mmpkt *mmhal_wlan_alloc_mmpkt_for_tx(uint8_t pkt_class, uint32_t space_at_start, uint32_t space_at_end,
|
||||
uint32_t metadata_length);
|
||||
|
||||
/**
|
||||
* Allocates an mmpkt for reception.
|
||||
*
|
||||
* @param capacity Amount of space to allocate for data.
|
||||
* @param metadata_length Amount of space to allocate for metadata (used internally by the
|
||||
* Morse driver).
|
||||
*
|
||||
* @returns a pointer to the allocated packet on success or @c NULL on allocation failure.
|
||||
*/
|
||||
struct mmpkt *mmhal_wlan_alloc_mmpkt_for_rx(uint32_t capacity, uint32_t metadata_length);
|
||||
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup MMHAL_WLAN_SDIO WLAN HAL API for SDIO interface
|
||||
*
|
||||
* API for communicating with the WLAN transceiver over an SDIO interface
|
||||
*
|
||||
* @warning These functions shall not be called directly by the end application they are for use
|
||||
* by Morselib.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** Enumeration of error codes that may be returned from @c mmhal_wlan_sdio_XXX() functions. */
|
||||
enum mmhal_sdio_error_codes {
|
||||
/** Invalid argument given (e.g., incorrect buffer alignment). */
|
||||
MMHAL_SDIO_INVALID_ARGUMENT = -1,
|
||||
/** Local hardware error (e.g., issue with SDIO controller). */
|
||||
MMHAL_SDIO_HW_ERROR = -2,
|
||||
/** Timeout executing SDIO command. */
|
||||
MMHAL_SDIO_CMD_TIMEOUT = -3,
|
||||
/** CRC error executing SDIO command. */
|
||||
MMHAL_SDIO_CMD_CRC_ERROR = -4,
|
||||
/** Timeout transferring data. */
|
||||
MMHAL_SDIO_DATA_TIMEOUT = -5,
|
||||
/** CRC error transferring data. */
|
||||
MMHAL_SDIO_DATA_CRC_ERROR = -6,
|
||||
/** Underflow filling SDIO controller FIFO. */
|
||||
MMHAL_SDIO_DATA_UNDERFLOW = -7,
|
||||
/** Overflow reading from SDIO controller FIFO. */
|
||||
MMHAL_SDIO_DATA_OVERRUN = -8,
|
||||
/** Another error not covered by the above error codes. */
|
||||
MMHAL_SDIO_OTHER_ERROR = -9,
|
||||
};
|
||||
|
||||
/**
|
||||
* Perform transport specific startup.
|
||||
*
|
||||
* @returns 0 on success, an error code from @ref mmhal_sdio_error_codes on failure.
|
||||
*/
|
||||
int mmhal_wlan_sdio_startup(void);
|
||||
|
||||
/**
|
||||
* Execute an SDIO command without data.
|
||||
*
|
||||
* @param[in] cmd_idx The Command Index.
|
||||
* @param[in] arg Command argument. This corresponds to the 32 bits of the command between
|
||||
* the Command Index field and the CRC7 field.
|
||||
* @param[out] rsp The contents of the command response between the Command Index field
|
||||
* and the CRC7 field. May be @c NULL if the response is not required.
|
||||
* The returned value is undefined if the return code is not zero.
|
||||
*
|
||||
* @returns 0 on success, an error code from @ref mmhal_sdio_error_codes on failure.
|
||||
*/
|
||||
int mmhal_wlan_sdio_cmd(uint8_t cmd_idx, uint32_t arg, uint32_t *rsp);
|
||||
|
||||
/**
|
||||
* Arguments structure for @ref mmhal_wlan_sdio_cmd53_write().
|
||||
*/
|
||||
struct mmhal_wlan_sdio_cmd53_write_args {
|
||||
/** The SDIO argument. This corresponds to the 32 bits of the command between
|
||||
* the Command Index field and the CRC7 field. */
|
||||
uint32_t sdio_arg;
|
||||
/** Pointer to the data buffer. 32 bit word aligned. */
|
||||
const uint8_t *data;
|
||||
/** Transfer length measured in blocks if block_size is non-zero otherwise in bytes.
|
||||
* If transfer_length is measured in bytes, it will be a multiple of 4. */
|
||||
uint16_t transfer_length;
|
||||
/**
|
||||
* If non-zero this indicates that the data should be transferred in block mode with
|
||||
* the given block size. If zero then the data should be transferred in byte mode and
|
||||
* @c transfer_length is guaranteed to not exceed the block size of the function.
|
||||
*/
|
||||
uint16_t block_size;
|
||||
};
|
||||
|
||||
/**
|
||||
* Execute an SDIO CMD53 write.
|
||||
*
|
||||
* @param args The write arguments.
|
||||
*
|
||||
* @returns 0 on success, an error code from @ref mmhal_sdio_error_codes on failure.
|
||||
*/
|
||||
int mmhal_wlan_sdio_cmd53_write(const struct mmhal_wlan_sdio_cmd53_write_args *args);
|
||||
|
||||
/**
|
||||
* Arguments structure for @ref mmhal_wlan_sdio_cmd53_read().
|
||||
*/
|
||||
struct mmhal_wlan_sdio_cmd53_read_args {
|
||||
/** The SDIO argument. This corresponds to the 32 bits of the command between
|
||||
* the Command Index field and the CRC7 field. */
|
||||
uint32_t sdio_arg;
|
||||
/** Pointer to the data buffer to receive the data. 32 bit word aligned. */
|
||||
uint8_t *data;
|
||||
/** Transfer length measured in blocks if block_size is non-zero otherwise in bytes.
|
||||
* If transfer_length is measured in bytes, it will be a multiple of 4. */
|
||||
uint16_t transfer_length;
|
||||
/**
|
||||
* If non-zero this indicates that the data should be transferred in block mode with
|
||||
* the given block size. If zero then the data should be transferred in byte mode and
|
||||
* @c transfer_length is guaranteed to not exceed the block size of the function.
|
||||
*/
|
||||
uint16_t block_size;
|
||||
};
|
||||
|
||||
/**
|
||||
* Execute an SDIO CMD53 read.
|
||||
*
|
||||
* @param args The read arguments.
|
||||
*
|
||||
* @returns 0 on success, an error code from @ref mmhal_sdio_error_codes on failure.
|
||||
*/
|
||||
int mmhal_wlan_sdio_cmd53_read(const struct mmhal_wlan_sdio_cmd53_read_args *args);
|
||||
|
||||
/**
|
||||
* @defgroup MMHAL_WLAN_SDIO_UTILS SDIO Utilities
|
||||
*
|
||||
* Useful macros and inline utilities function for use by SDIO and SPI HALs.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/*
|
||||
* SDIO argument definition, per SDIO Specification Version 4.10, Part E1, Section 5.3.
|
||||
*/
|
||||
|
||||
/** SDIO CMD52/CMD53 R/W flag. */
|
||||
enum mmhal_sdio_rw {
|
||||
MMHAL_SDIO_READ = 0, /**< Read operation */
|
||||
MMHAL_SDIO_WRITE = (1ul << 31), /**< Write operation */
|
||||
};
|
||||
|
||||
/** SDIO CMD52/CMD53 function number. */
|
||||
enum mmhal_sdio_function {
|
||||
MMHAL_SDIO_FUNCTION_0 = 0, /** Function 0 */
|
||||
MMHAL_SDIO_FUNCTION_1 = (1ul << 28), /** Function 1 */
|
||||
MMHAL_SDIO_FUNCTION_2 = (2ul << 28), /** Function 2 */
|
||||
};
|
||||
|
||||
/** SDIO CMD53 block mode*/
|
||||
enum mmhal_sdio_mode {
|
||||
MMHAL_SDIO_MODE_BYTE = 0, /** Byte mode */
|
||||
MMHAL_SDIO_MODE_BLOCK = (1ul << 27), /** Block mode */
|
||||
};
|
||||
|
||||
/** SDIO CMD53 OP code */
|
||||
enum mmhal_sdio_opcode {
|
||||
/** Operate on a single, fixed address. */
|
||||
MMHAL_SDIO_OPCODE_FIXED_ADDR = 0,
|
||||
/** Increment address by 1 after each byte. */
|
||||
MMHAL_SDIO_OPCODE_INC_ADDR = (1ul << 26),
|
||||
};
|
||||
|
||||
/** CMD52/53 Register Address (17 bit) offset. */
|
||||
#define MMHAL_SDIO_ADDRESS_OFFSET (9)
|
||||
/** CMD52/53 Register Address maximum value. */
|
||||
#define MMHAL_SDIO_ADDRESS_MAX ((1ul << 18) - 1)
|
||||
|
||||
/** CMD53 Byte/block count offset (9 bit). */
|
||||
#define MMHAL_SDIO_COUNT_OFFSET (0)
|
||||
/**CMD53 Byte/block count maximum value. */
|
||||
#define MMHAL_SDIO_COUNT_MAX ((1ul << 10) - 1)
|
||||
|
||||
/** CMD52 Data (8 bit) offset */
|
||||
#define MMHAL_SDIO_CMD52_DATA_OFFSET (0)
|
||||
|
||||
/**
|
||||
* Construct an SDIO CMD52 argument based on the given arguments.
|
||||
*
|
||||
* @param rw Flag indication direction (read or write).
|
||||
* @param fn The applicable function.
|
||||
* @param address The address to read/write. Must be <= @c MMHAL_SDIO_ADDRESS_MAX.
|
||||
* @param write_data The data to write if this is a write operation. Should be set to zero
|
||||
* for a read operation.
|
||||
*
|
||||
* @return the SDIO CMD52 argument generated based on the given arguments.
|
||||
*/
|
||||
static inline uint32_t mmhal_make_cmd52_arg(enum mmhal_sdio_rw rw, enum mmhal_sdio_function fn, uint32_t address,
|
||||
uint8_t write_data)
|
||||
{
|
||||
uint32_t arg;
|
||||
|
||||
arg = rw | fn;
|
||||
arg |= (address << MMHAL_SDIO_ADDRESS_OFFSET);
|
||||
arg |= (write_data << MMHAL_SDIO_CMD52_DATA_OFFSET);
|
||||
return arg;
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct an SDIO CMD53 argument based on the given arguments.
|
||||
*
|
||||
* @param rw Flag indication direction (read or write).
|
||||
* @param fn The applicable function.
|
||||
* @param mode Selects between byte and block mode.
|
||||
* @param address The address to read/write. Must be <= @c MMHAL_SDIO_ADDRESS_MAX.
|
||||
* @param count The count of bytes/blocks (depending on @p mode) to transfer. Must
|
||||
* be <= @c MMHAL_SDIO_COUNT_MAX.
|
||||
*
|
||||
* @note OP Code 1 (incrementing address) is assumed. See also @ref MMHAL_SDIO_OPCODE_INC_ADDR.
|
||||
*
|
||||
* @return the SDIO CMD53 argument generated based on the given arguments.
|
||||
*/
|
||||
static inline uint32_t mmhal_make_cmd53_arg(enum mmhal_sdio_rw rw, enum mmhal_sdio_function fn, enum mmhal_sdio_mode mode,
|
||||
uint32_t address, uint16_t count)
|
||||
{
|
||||
uint32_t arg;
|
||||
|
||||
arg = rw | fn | MMHAL_SDIO_OPCODE_INC_ADDR | mode;
|
||||
arg |= (address << MMHAL_SDIO_ADDRESS_OFFSET);
|
||||
arg |= (count << MMHAL_SDIO_COUNT_OFFSET);
|
||||
return arg;
|
||||
}
|
||||
|
||||
/** @} */
|
||||
|
||||
/** @} */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,383 @@
|
||||
/*
|
||||
* Copyright 2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMIPAL Morse Micro IP Stack Abstraction Layer (MMIPAL) API
|
||||
*
|
||||
* This API provides a layer of abstraction from the underlying IP stack for common operations
|
||||
* such as configuring the link and getting link status.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
|
||||
/** Maximum length of an IP address string, including null-terminator. */
|
||||
#ifndef MMIPAL_IPADDR_STR_MAXLEN
|
||||
#define MMIPAL_IPADDR_STR_MAXLEN (48)
|
||||
#endif
|
||||
|
||||
/** Maximum number of IPv6 addresses supported. */
|
||||
#ifndef MMIPAL_MAX_IPV6_ADDRESSES
|
||||
#define MMIPAL_MAX_IPV6_ADDRESSES (3)
|
||||
#endif
|
||||
|
||||
/** Enumeration of status codes returned by MMIPAL functions. */
|
||||
enum mmipal_status {
|
||||
/** Completed successfully. */
|
||||
MMIPAL_SUCCESS,
|
||||
/** One or more arguments were invalid. */
|
||||
MMIPAL_INVALID_ARGUMENT,
|
||||
/** The operation could not complete because the link is not up. */
|
||||
MMIPAL_NO_LINK,
|
||||
/** Failed due to memory allocation failure. */
|
||||
MMIPAL_NO_MEM,
|
||||
/** This functionality is not supported (e.g., due to build configuration). */
|
||||
MMIPAL_NOT_SUPPORTED,
|
||||
};
|
||||
|
||||
/** Enumeration of link states. */
|
||||
enum mmipal_link_state {
|
||||
/** Link is down. */
|
||||
MMIPAL_LINK_DOWN,
|
||||
/** Link is up. */
|
||||
MMIPAL_LINK_UP,
|
||||
};
|
||||
|
||||
/** Enumeration of IP address allocation modes. */
|
||||
enum mmipal_addr_mode {
|
||||
/** Disabled. */
|
||||
MMIPAL_DISABLED,
|
||||
/** Static IP address. */
|
||||
MMIPAL_STATIC,
|
||||
/** IP address allocated via DHCP. @c LWIP_DHCP must be set to 1 if using LWIP. */
|
||||
MMIPAL_DHCP,
|
||||
/** IP address allocated via AutoIP. @c LWIP_DHCP must be set to 1 if using LWIP. */
|
||||
MMIPAL_AUTOIP,
|
||||
/** DHCP offloaded to chip. */
|
||||
MMIPAL_DHCP_OFFLOAD,
|
||||
};
|
||||
|
||||
/** IP address string type. */
|
||||
typedef char mmipal_ip_addr_t[MMIPAL_IPADDR_STR_MAXLEN];
|
||||
|
||||
/**
|
||||
* IPv4 configuration structure.
|
||||
*
|
||||
* This should be initialized using @c MMIPAL_IP_CONFIG_DEFAULT.
|
||||
* For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* struct mmipal_ip_config config = MMIPAL_IP_CONFIG_DEAFULT;
|
||||
* @endcode
|
||||
*/
|
||||
struct mmipal_ip_config {
|
||||
/** IP address allocation mode. */
|
||||
enum mmipal_addr_mode mode;
|
||||
/** local IP address */
|
||||
mmipal_ip_addr_t ip_addr;
|
||||
/** Netmask address */
|
||||
mmipal_ip_addr_t netmask;
|
||||
/** Gateway address */
|
||||
mmipal_ip_addr_t gateway_addr;
|
||||
};
|
||||
|
||||
/** Initializer for @ref mmipal_ip_config. */
|
||||
#define MMIPAL_IP_CONFIG_DEFAULT \
|
||||
{ \
|
||||
MMIPAL_DHCP, "", "", "", \
|
||||
}
|
||||
|
||||
/** Enumeration of IPv6 address allocation modes. */
|
||||
enum mmipal_ip6_addr_mode {
|
||||
/** Disabled. */
|
||||
MMIPAL_IP6_DISABLED,
|
||||
/** Static IPv6 addresses. */
|
||||
MMIPAL_IP6_STATIC,
|
||||
/** IPv6 address allocated via autoconfiguration.
|
||||
* @c LWIP_IPV6_AUTOCONFIG must be set to 1 if using LWIP. */
|
||||
MMIPAL_IP6_AUTOCONFIG,
|
||||
/** IPv6 address allocated via stateless DHCPv6.
|
||||
* @c LWIP_IPV6_DHCP6_STATELESS must be set to 1 if using LWIP. */
|
||||
MMIPAL_IP6_DHCP6_STATELESS,
|
||||
};
|
||||
|
||||
/**
|
||||
* IPv6 configuration structure.
|
||||
*
|
||||
* This should be initialized using @c MMIPAL_IP6_CONFIG_DEFAULT.
|
||||
* For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* struct mmipal_ip6_config config = MMIPAL_IP6_CONFIG_DEFAULT;
|
||||
* @endcode
|
||||
*/
|
||||
struct mmipal_ip6_config {
|
||||
/** IPv6 addresses allocation mode. */
|
||||
enum mmipal_ip6_addr_mode ip6_mode;
|
||||
/** Array of IPv6 addresses. */
|
||||
mmipal_ip_addr_t ip6_addr[MMIPAL_MAX_IPV6_ADDRESSES];
|
||||
};
|
||||
|
||||
/** Initializer for @ref mmipal_ip6_config. */
|
||||
#define MMIPAL_IP6_CONFIG_DEFAULT \
|
||||
{ \
|
||||
MMIPAL_IP6_AUTOCONFIG \
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize arguments structure.
|
||||
*
|
||||
* This should be initialized using @c MMIPAL_INIT_ARGS_DEFAULT.
|
||||
* For example:
|
||||
*
|
||||
* @code{.c}
|
||||
* struct mmipal_init_args args = MMIPAL_INIT_ARGS_DEFAULT;
|
||||
* @endcode
|
||||
*/
|
||||
struct mmipal_init_args {
|
||||
/** IP address allocation mode to use. */
|
||||
enum mmipal_addr_mode mode;
|
||||
/** IP address to use (if @c mode is @c MMIPAL_STATIC). */
|
||||
mmipal_ip_addr_t ip_addr;
|
||||
/** Netmask to use (if @c mode is @c MMIPAL_STATIC). */
|
||||
mmipal_ip_addr_t netmask;
|
||||
/** Gateway IP address to use (if @c mode is @c MMIPAL_STATIC). */
|
||||
mmipal_ip_addr_t gateway_addr;
|
||||
|
||||
/** IPv6 address allocation mode to use. */
|
||||
enum mmipal_ip6_addr_mode ip6_mode;
|
||||
/** IPv6 address to use (if @c ip6_mode is @c MMIPAL_IP6_STATIC). */
|
||||
mmipal_ip_addr_t ip6_addr;
|
||||
/** Flag requesting ARP response offload feature */
|
||||
bool offload_arp_response;
|
||||
/** ARP refresh offload interval in seconds */
|
||||
uint32_t offload_arp_refresh_s;
|
||||
};
|
||||
|
||||
/**
|
||||
* Default values for @ref mmipal_init_args. This should be used when initializing the
|
||||
* @ref mmipal_init_args structure.
|
||||
*/
|
||||
#define MMIPAL_INIT_ARGS_DEFAULT \
|
||||
{ \
|
||||
MMIPAL_DHCP, {0}, {0}, {0}, MMIPAL_IP6_DISABLED, {0}, false, 0 \
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize the IP stack and enable the MMWLAN interface.
|
||||
*
|
||||
* This will implicitly initialize and boot MMWLAN, and will block until this has completed.
|
||||
*
|
||||
* @note This function will boot the Morse Micro transceiver using @ref mmwlan_boot() in order
|
||||
* to read the MAC address. It is the responsibility of the caller to shut down the
|
||||
* transceiver using @ref mmwlan_shutdown() as required.
|
||||
*
|
||||
* @warning @ref mmwlan_init() must be called before invoking this function.
|
||||
*
|
||||
* @param args Initialization arguments.
|
||||
*
|
||||
* @return @c MMIPAL_SUCCESS on success. otherwise a vendor specific error code.
|
||||
*/
|
||||
enum mmipal_status mmipal_init(const struct mmipal_init_args *args);
|
||||
|
||||
/**
|
||||
* Structure representing the current status of the link.
|
||||
*/
|
||||
struct mmipal_link_status {
|
||||
/** State of the link (up/down). */
|
||||
enum mmipal_link_state link_state;
|
||||
/** Current IP address. */
|
||||
mmipal_ip_addr_t ip_addr;
|
||||
/** Current netmask. */
|
||||
mmipal_ip_addr_t netmask;
|
||||
/** Current gateway IP address. */
|
||||
mmipal_ip_addr_t gateway;
|
||||
};
|
||||
|
||||
/**
|
||||
* Prototype for callback function invoked on link status changes.
|
||||
*
|
||||
* @param link_status The current link status.
|
||||
*/
|
||||
typedef void (*mmipal_link_status_cb_fn_t)(const struct mmipal_link_status *link_status);
|
||||
|
||||
/**
|
||||
* Sets the callback function to be invoked on link status changes.
|
||||
*
|
||||
* This will be used when DHCP is enabled.
|
||||
*
|
||||
* @note This is for IPv4 only. To get IPv6 status use @c mmipal_get_ip6_config.
|
||||
* @note If an opaque argument is required then use @ref mmipal_set_ext_link_status_callback()
|
||||
* instead.
|
||||
*
|
||||
* @param fn Function pointer to the callback function.
|
||||
*/
|
||||
void mmipal_set_link_status_callback(mmipal_link_status_cb_fn_t fn);
|
||||
|
||||
/**
|
||||
* Prototype for callback function invoked on link status changes.
|
||||
*
|
||||
* This is similar to @ref mmipal_link_status_cb_fn_t but with the addition of the @p arg
|
||||
* parameter.
|
||||
*
|
||||
* @param link_status The current link status.
|
||||
* @param arg Opaque argument that was provided when the callback was registered.
|
||||
*/
|
||||
typedef void (*mmipal_ext_link_status_cb_fn_t)(const struct mmipal_link_status *link_status, void *arg);
|
||||
|
||||
/**
|
||||
* Sets the extended link status callback function to be invoked on link status changes.
|
||||
* This is similar to @ref mmipal_set_link_status_callback() with the exception that
|
||||
* an opaque argument may also be specified.
|
||||
*
|
||||
* This will be used when DHCP is enabled.
|
||||
*
|
||||
* @note This is for IPv4 only. To get IPv6 status use @c mmipal_get_ip6_config.
|
||||
*
|
||||
* @param fn Function pointer to the callback function.
|
||||
* @param arg Opaque argument to be passed to the callback.
|
||||
*/
|
||||
void mmipal_set_ext_link_status_callback(mmipal_ext_link_status_cb_fn_t fn, void *arg);
|
||||
|
||||
/**
|
||||
* Get the total number of transmitted and received packets on the MMWLAN interface
|
||||
*
|
||||
* @note If using LWIP, this function requires LWIP_STATS to be defined in your application,
|
||||
* otherwise packet counters will always return as 0.
|
||||
*
|
||||
* @param tx_packets Pointer to location to store total tx packets
|
||||
* @param rx_packets Pointer to location to store total rx packets
|
||||
*/
|
||||
void mmipal_get_link_packet_counts(uint32_t *tx_packets, uint32_t *rx_packets);
|
||||
|
||||
/**
|
||||
* Set the QoS Traffic ID to use when transmitting.
|
||||
*
|
||||
* @param tid The QoS TID to use (0 - @ref MMWLAN_MAX_QOS_TID).
|
||||
*/
|
||||
void mmipal_set_tx_qos_tid(uint8_t tid);
|
||||
|
||||
/**
|
||||
* Gets the local address for the MMWLAN interface that is appropriate for a given
|
||||
* destination address.
|
||||
*
|
||||
* The following table shows how the returned @c local_addr is selected:
|
||||
*
|
||||
* | @p dest_addr | @c local_addr returned |
|
||||
* |--------------|---------------------------|
|
||||
* | type is IPv4 | IPv4 address |
|
||||
* | type is IPv6 | An IPv6 source address selected from interface's IPv6 addresses or ERR_CONN |
|
||||
*
|
||||
* (X = don't care)
|
||||
*
|
||||
* If the given parameters would result in a @p local_addr type of IPv4 and IPv4 is not enabled,
|
||||
* or IPv6 and IPv6 is not enabled, then @c MMIPAL_INVALID_ARGUMENT will be returned.
|
||||
*
|
||||
* @param[out] local_addr Output local address for the MMWLAN interface, as noted above.
|
||||
* @param[in] dest_addr Destination address.
|
||||
*
|
||||
* @return @c MMIPAL_SUCESS if @p local_addr successfully set. otherwise an
|
||||
* appropriate error code.
|
||||
*/
|
||||
enum mmipal_status mmipal_get_local_addr(mmipal_ip_addr_t local_addr, const mmipal_ip_addr_t dest_addr);
|
||||
|
||||
/**
|
||||
* Get the IP configurations.
|
||||
*
|
||||
* This can be used to get the local IP configurations.
|
||||
*
|
||||
* @param config Pointer to the IP configurations.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_NOT_SUPPORTED if IPv4 is not supported.
|
||||
*/
|
||||
enum mmipal_status mmipal_get_ip_config(struct mmipal_ip_config *config);
|
||||
|
||||
/**
|
||||
* Set the IP configurations.
|
||||
*
|
||||
* This can be used to set the local IP configurations.
|
||||
*
|
||||
* @param config Pointer to the IP configurations.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_NOT_SUPPORTED if IPv4 is not supported.
|
||||
*/
|
||||
enum mmipal_status mmipal_set_ip_config(const struct mmipal_ip_config *config);
|
||||
|
||||
/**
|
||||
* Gets the current IPv4 broadcast address.
|
||||
*
|
||||
* @param[out] broadcast_addr Buffer to receive the broadcast address as a string.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_NOT_SUPPORTED if IPv4 is not supported.
|
||||
*/
|
||||
enum mmipal_status mmipal_get_ip_broadcast_addr(mmipal_ip_addr_t broadcast_addr);
|
||||
|
||||
/**
|
||||
* Get the IP configurations.
|
||||
*
|
||||
* This can be used to get the local IP configurations.
|
||||
*
|
||||
* @param config Pointer to the IP configurations.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_NOT_SUPPORTED if IPv6 is not supported..
|
||||
*/
|
||||
enum mmipal_status mmipal_get_ip6_config(struct mmipal_ip6_config *config);
|
||||
|
||||
/**
|
||||
* Set the IPv6 configurations.
|
||||
*
|
||||
* This can be used to set the local IPv6 configurations.
|
||||
*
|
||||
* @param config Pointer to the IPv6 configurations.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_NOT_SUPPORTED if IPv6 is not supported.
|
||||
*/
|
||||
enum mmipal_status mmipal_set_ip6_config(const struct mmipal_ip6_config *config);
|
||||
|
||||
/**
|
||||
* Get current IPv4 link state.
|
||||
*
|
||||
* @returns the current IPv4 link state (up or down).
|
||||
*/
|
||||
enum mmipal_link_state mmipal_get_link_state(void);
|
||||
|
||||
/**
|
||||
* Set the DNS server at the given index.
|
||||
*
|
||||
* @warning Depending on IP stack implementation, this setting may be overridden by DHCP.
|
||||
*
|
||||
* @param[in] index Index of the DNS server to set.
|
||||
* @param[out] addr Address of the DNS server to set.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success, @c MMIPAL_INVALID_ARGUMENT if an invalid index or IP
|
||||
* address was given.
|
||||
*/
|
||||
enum mmipal_status mmipal_set_dns_server(uint8_t index, const mmipal_ip_addr_t addr);
|
||||
|
||||
/**
|
||||
* Get the DNS server at the given index.
|
||||
*
|
||||
* @param[in] index Index of the DNS server to set.
|
||||
* @param[out] addr IP address buffer to receive the IP address of the DNS server at the given
|
||||
* index. Will be set to empty string if no server at the given index.
|
||||
*
|
||||
* @returns @c MMIPAL_SUCCESS on success.
|
||||
*/
|
||||
enum mmipal_status mmipal_get_dns_server(uint8_t index, mmipal_ip_addr_t addr);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,64 @@
|
||||
/*
|
||||
* Morse logging API
|
||||
*
|
||||
* Copyright 2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* Macro for printing a @c uint64_t as two separate @c uint32_t values. This is to allow printing of
|
||||
* these values even when the @c printf implementation doesn't support it.
|
||||
*/
|
||||
#define MM_X64_VAL(value) ((uint32_t)(value >> 32)), ((uint32_t)value)
|
||||
|
||||
/** Macro for format specifier to print @ref MM_X64_VAL */
|
||||
#define MM_X64_FMT "%08lx%08lx"
|
||||
|
||||
/**
|
||||
* Macro for printing a MAC address. This saves writing it out by hand.
|
||||
*
|
||||
* Must be used in conjunction with @ref MM_MAC_ADDR_FMT. For example:
|
||||
*
|
||||
* @code
|
||||
* uint8_t mac_addr[] = { 0, 1, 2, 3, 4, 5 };
|
||||
* printf("MAC address: " MM_MAC_ADDR_FMT "\n", MM_MAC_ADDR_VAL(mac_addr));
|
||||
* @endcode
|
||||
*/
|
||||
#define MM_MAC_ADDR_VAL(value) ((value)[0]), ((value)[1]), ((value)[2]), ((value)[3]), ((value)[4]), ((value)[5])
|
||||
|
||||
/** Macro for format specifier to print @ref MM_MAC_ADDR_VAL */
|
||||
#define MM_MAC_ADDR_FMT "%02x:%02x:%02x:%02x:%02x:%02x"
|
||||
|
||||
/**
|
||||
* Initialize Morse logging API.
|
||||
*
|
||||
* This should be invoked after OS initialization since it will create a mutex for
|
||||
* logging.
|
||||
*/
|
||||
void mm_logging_init(void);
|
||||
|
||||
/**
|
||||
* Dumps a binary buffer in hex.
|
||||
*
|
||||
* @param level A single character indicating log level.
|
||||
* @param function Name of function this was invoked from.
|
||||
* @param line_number Line number this was invoked from.
|
||||
* @param title Title of the buffer.
|
||||
* @param buf The buffer to dump.
|
||||
* @param len Length of the buffer.
|
||||
*/
|
||||
void mm_hexdump(char level, const char *function, unsigned line_number, const char *title, const uint8_t *buf, size_t len);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,515 @@
|
||||
/*
|
||||
* Copyright 2022-2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMPKT Morse Micro Packet Buffer (mmpkt) API
|
||||
*
|
||||
* This API provides support for buffers tailored towards packets.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "mmosal.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Round @p x up to the next multiple of @p m (where @p m is a power of 2).
|
||||
*
|
||||
* @warning @p m must be a power of 2.
|
||||
*/
|
||||
#ifndef MM_FAST_ROUND_UP
|
||||
#define MM_FAST_ROUND_UP(x, m) ((((x)-1) | ((m)-1)) + 1)
|
||||
#endif
|
||||
|
||||
struct mmdrv_cmd_metadata;
|
||||
struct mmdrv_tx_metadata;
|
||||
struct mmdrv_rx_metadata;
|
||||
struct mmpkt_ops;
|
||||
|
||||
/**
|
||||
* Union of pointer types for mmpkt metadata.
|
||||
*
|
||||
* The metadata is accessed through one of these pointers, depending on which context the packet
|
||||
* is being used in.
|
||||
*/
|
||||
union mmpkt_metadata_ptr {
|
||||
/** Opaque pointer for contexts which are unaware of the specific metadata structure. */
|
||||
void *opaque;
|
||||
/** Metadata for a packet which is being transmitted. */
|
||||
struct mmdrv_tx_metadata *tx;
|
||||
/** Metadata for a packet which is being received. */
|
||||
struct mmdrv_rx_metadata *rx;
|
||||
/** Control block for a command response sent to the host. */
|
||||
struct mmdrv_cmd_metadata *cmd;
|
||||
};
|
||||
|
||||
/**
|
||||
* Core mmpkt data structure.
|
||||
*
|
||||
* @note The contents of this data structure should never need to be accessed directly. Rather
|
||||
* the various functions provided as part of this API should be used.
|
||||
*
|
||||
* @code
|
||||
* +----------------------------------------------------------+--------------+
|
||||
* | RESERVED | Data | RESERVED | METADATA |
|
||||
* +----------------------------------------------------------+--------------+
|
||||
* ^ ^ ^ ^
|
||||
* | | | |
|
||||
* | |<-----------data_len--------->| |
|
||||
* | start_offset |
|
||||
* | |
|
||||
* |<-----------------------buf_len-------------------------->|
|
||||
* buf
|
||||
* @endcode
|
||||
*/
|
||||
struct mmpkt {
|
||||
/** The buffer where data is stored. */
|
||||
uint8_t *buf;
|
||||
/** Length of the buffer. */
|
||||
uint32_t buf_len;
|
||||
/** Offset where actual data starts in the buffer. */
|
||||
uint32_t start_offset;
|
||||
/** Length of actual data in the buffer. */
|
||||
uint32_t data_len;
|
||||
/** Packet metadata used by driver (context dependent). */
|
||||
union mmpkt_metadata_ptr metadata;
|
||||
/** Reference to operations data structure for this mmpkt. */
|
||||
const struct mmpkt_ops *ops;
|
||||
/** Pointer that can be used to construct linked lists. */
|
||||
struct mmpkt *volatile next;
|
||||
};
|
||||
|
||||
/** Operations data structure for mmpkt. */
|
||||
struct mmpkt_ops {
|
||||
/** Free the given mmpkt. */
|
||||
void (*free_mmpkt)(void *mmpkt);
|
||||
};
|
||||
|
||||
/**
|
||||
* Opened view of an mmpkt.
|
||||
*
|
||||
* In this implementation, this structure does not actually exist. We only use it as a pointer type
|
||||
* which is incompatible with @ref mmpkt, to distinguish between functions which operate on opened
|
||||
* packet views versus functions which can operate on unopened packets.
|
||||
*
|
||||
* In other implementations of this API, packets must be "opened" (mapped into memory) before their
|
||||
* contents can be accessed. Thus the distinction between opened and unopened packets is important
|
||||
* for those implementations.
|
||||
*/
|
||||
struct mmpktview;
|
||||
|
||||
/**
|
||||
* Initialize an mmpkt header with the given values.
|
||||
*
|
||||
* @param mmpkt mmpkt to initialize.
|
||||
* @param buf Pointer to buffer.
|
||||
* @param buf_len Length of @p buf.
|
||||
* @param data_start_offset Initial value for @c start_offset.
|
||||
* @param ops Operations data structure.
|
||||
*/
|
||||
static inline void mmpkt_init(struct mmpkt *mmpkt, uint8_t *buf, uint32_t buf_len, uint32_t data_start_offset,
|
||||
const struct mmpkt_ops *ops)
|
||||
{
|
||||
memset(mmpkt, 0, sizeof(*mmpkt));
|
||||
mmpkt->buf = buf;
|
||||
mmpkt->buf_len = buf_len;
|
||||
mmpkt->start_offset = data_start_offset;
|
||||
mmpkt->ops = ops;
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialize an mmpkt in a single buffer using the given values.
|
||||
*
|
||||
* @param buf Pointer to buffer.
|
||||
* @param buf_len Length of @p buf.
|
||||
* @param space_at_start Amount of space to reserve at start of buffer.
|
||||
* @param space_at_end Amount of space to reserve at end of buffer.
|
||||
* @param metadata_size Size of metadata (0 for no metadata).
|
||||
*
|
||||
* @param ops Operations data structure.
|
||||
*
|
||||
* @note @p buf_len must be large enough to contain the @c mmkpt header, the data buffer
|
||||
* (rounded up to the nearest 4 bytes) and metadata (rounded up to the nearest 4 bytes).
|
||||
*
|
||||
* @returns a pointer to the initialized @c mmpkt (will be the same address as @p buf) or @c NULL
|
||||
* on error (@p buf length too short).
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_init_buf(uint8_t *buf, uint32_t buf_len, uint32_t space_at_start, uint32_t space_at_end,
|
||||
uint32_t metadata_size, const struct mmpkt_ops *ops)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)buf;
|
||||
|
||||
uint8_t *data_start;
|
||||
uint32_t header_size = MM_FAST_ROUND_UP(sizeof(*mmpkt), 4);
|
||||
uint32_t data_len = MM_FAST_ROUND_UP(space_at_start + space_at_end, 4);
|
||||
metadata_size = MM_FAST_ROUND_UP(metadata_size, 4);
|
||||
|
||||
if (header_size + data_len + metadata_size > buf_len) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
data_start = ((uint8_t *)mmpkt) + header_size;
|
||||
|
||||
mmpkt_init(mmpkt, data_start, data_len, space_at_start, ops);
|
||||
|
||||
if (metadata_size != 0) {
|
||||
mmpkt->metadata.opaque = data_start + data_len;
|
||||
memset(mmpkt->metadata.opaque, 0, metadata_size);
|
||||
}
|
||||
|
||||
return mmpkt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Allocate a new mmpkt on the heap (using @ref mmosal_malloc()).
|
||||
*
|
||||
* @param space_at_start Amount of space to reserve at start of buffer.
|
||||
* @param space_at_end Amount of space to reserve at end of buffer.
|
||||
* @param metadata_size Size of metadata (0 for no metadata).
|
||||
*
|
||||
* @note @c start_offset will be set to @p space_at_start, and @c buf_len will be the sum
|
||||
* of @p space_at_start and @p space_at_end (rounded up to a multiple of 4).
|
||||
*
|
||||
* @returns newly allocated mmpkt on success or @c NULL on failure.
|
||||
*/
|
||||
struct mmpkt *mmpkt_alloc_on_heap(uint32_t space_at_start, uint32_t space_at_end, uint32_t metadata_size);
|
||||
|
||||
/**
|
||||
* Release a reference to the given mmpkt. If this was the last reference (@c addition_ref_cnt
|
||||
* was 0) then the mmpkt will be freed using the appropriate op callback.
|
||||
*
|
||||
* @param mmpkt The mmpkt to release reference to. May be @c NULL.
|
||||
*/
|
||||
void mmpkt_release(struct mmpkt *mmpkt);
|
||||
|
||||
/**
|
||||
* Open a view of the given mmpkt.
|
||||
*
|
||||
* Packets must be opened before the contents of their buffer can be accessed. Most of the
|
||||
* functions below expect to be passed an opened view of a packet to operate on.
|
||||
*
|
||||
* The view must be closed by calling @ref mmpkt_close() before the packet is released by
|
||||
* @ref mmpkt_release().
|
||||
*
|
||||
* @param mmpkt The mmpkt to be opened.
|
||||
*
|
||||
* @returns a pointer representing the opened view.
|
||||
*/
|
||||
static inline struct mmpktview *mmpkt_open(struct mmpkt *mmpkt)
|
||||
{
|
||||
return (struct mmpktview *)mmpkt;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the given view.
|
||||
*
|
||||
* @param[in,out] view Pointer to a variable holding the view to be closed.
|
||||
* This will be modified to indicate it is no longer valid.
|
||||
*/
|
||||
static inline void mmpkt_close(struct mmpktview **view)
|
||||
{
|
||||
(void)(view);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the underlying mmpkt from an opened view.
|
||||
*
|
||||
* @param view View of an mmpkt.
|
||||
*
|
||||
* @returns the underlying mmpkt.
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_from_view(struct mmpktview *view)
|
||||
{
|
||||
return (struct mmpkt *)view;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a pointer to the start of the data in the mmpkt.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
*
|
||||
* @returns a pointer to the start of the data in the mmpkt.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_get_data_start(struct mmpktview *view)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return mmpkt->buf + mmpkt->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a pointer to the end of the data in the mmpkt.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
*
|
||||
* @returns a pointer to the end of the data in the mmpkt.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_get_data_end(struct mmpktview *view)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return mmpkt->buf + mmpkt->start_offset + mmpkt->data_len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Peek the length of the data currently from an unopened mmpkt.
|
||||
*
|
||||
* @param mmpkt The unopened mmpkt to operate on.
|
||||
*
|
||||
* @returns the length of the data currently in the mmpkt (note that this is different from the
|
||||
* length of the available buffer space).
|
||||
*/
|
||||
static inline uint32_t mmpkt_peek_data_length(struct mmpkt *mmpkt)
|
||||
{
|
||||
return mmpkt->data_len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the length of the data currently in the mmpkt.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
*
|
||||
* @returns the length of the data currently in the mmpkt (note that this is different from the
|
||||
* length of the available buffer space).
|
||||
*/
|
||||
static inline uint32_t mmpkt_get_data_length(struct mmpktview *view)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return mmpkt->data_len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the amount of space available for prepending to the data in the buffer.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
*
|
||||
* @returns the available space in bytes.
|
||||
*/
|
||||
static inline uint32_t mmpkt_available_space_at_start(struct mmpktview *view)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return mmpkt->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the amount of space available for appending to the data in the buffer.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
*
|
||||
* @returns the available space in bytes.
|
||||
*/
|
||||
static inline uint32_t mmpkt_available_space_at_end(struct mmpktview *view)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return mmpkt->buf_len - (mmpkt->start_offset + mmpkt->data_len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reserves space immediately before the data currently in the given mmpkt and returns
|
||||
* a pointer to this space.
|
||||
*
|
||||
* For a function that also copies data in, see @ref mmpkt_prepend_data().
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmpkt_available_space_at_start().
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param len Length of data to be prepended.
|
||||
*
|
||||
* @returns a pointer to the place in the buffer where the data should be put.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_prepend(struct mmpktview *view, uint32_t len)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
MMOSAL_ASSERT(len <= mmpkt_available_space_at_start(view));
|
||||
mmpkt->start_offset -= len;
|
||||
mmpkt->data_len += len;
|
||||
return mmpkt->buf + mmpkt->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepends the given data to the data already in the mmpkt.
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmpkt_available_space_at_start().
|
||||
*
|
||||
* @warning The memory area pointed to by data must not overlap with the mmpkt data.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param data The data to be prepended.
|
||||
* @param len Length of data to be prepended.
|
||||
*/
|
||||
static inline void mmpkt_prepend_data(struct mmpktview *view, const uint8_t *data, uint32_t len)
|
||||
{
|
||||
uint8_t *dest = mmpkt_prepend(view, len);
|
||||
memcpy(dest, data, len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reserves space immediately after the data currently in the given mmpkt and returns
|
||||
* a pointer to this space.
|
||||
*
|
||||
* For a function that also copies data in, see @ref mmpkt_append_data().
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmpkt_available_space_at_end().
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param len Length of data to be append.
|
||||
*
|
||||
* @returns a pointer to the place in the buffer where the data should be put.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_append(struct mmpktview *view, uint32_t len)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
uint8_t *ret = mmpkt_get_data_end(view);
|
||||
MMOSAL_ASSERT(len <= mmpkt_available_space_at_end(view));
|
||||
mmpkt->data_len += len;
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the given data to the data already in the mmpkt.
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmpkt_available_space_at_start().
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param data The data to be prepended.
|
||||
* @param len Length of data to be prepended.
|
||||
*/
|
||||
static inline void mmpkt_append_data(struct mmpktview *view, const uint8_t *data, uint32_t len)
|
||||
{
|
||||
uint8_t *dest = mmpkt_append(view, len);
|
||||
memcpy(dest, data, len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a reference to the metadata associated with the given mmpkt.
|
||||
*
|
||||
* @param mmpkt The mmpkt to operate on.
|
||||
*
|
||||
* @returns a reference to the mmpkt metadata.
|
||||
*/
|
||||
static inline union mmpkt_metadata_ptr mmpkt_get_metadata(struct mmpkt *mmpkt)
|
||||
{
|
||||
return mmpkt->metadata;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove data from the start of the mmpkt.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param len Length of data to remove.
|
||||
*
|
||||
* @returns a pointer to the removed data or NULL if the mmpkt data length was less than @p len.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_remove_from_start(struct mmpktview *view, uint32_t len)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
uint8_t *ret;
|
||||
|
||||
if (mmpkt_get_data_length(view) < len) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
ret = mmpkt_get_data_start(view);
|
||||
|
||||
mmpkt->start_offset += len;
|
||||
mmpkt->data_len -= len;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove data from the end of the mmpkt.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param len Length of data to remove.
|
||||
*
|
||||
* @returns a pointer to the removed data or NULL if the mmpkt data length was less than @p len.
|
||||
*/
|
||||
static inline uint8_t *mmpkt_remove_from_end(struct mmpktview *view, uint32_t len)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
uint8_t *ret;
|
||||
|
||||
if (mmpkt_get_data_length(view) < len) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
ret = mmpkt_get_data_end(view) - len;
|
||||
|
||||
mmpkt->data_len -= len;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Truncate the mmpkt data to the given length.
|
||||
*
|
||||
* @param mmpkt mmpkt to operate on.
|
||||
* @param len New data length. (Must be less than or equal to the data length
|
||||
* of the mmpkt).
|
||||
*/
|
||||
static inline void mmpkt_truncate(struct mmpkt *mmpkt, uint32_t len)
|
||||
{
|
||||
MMOSAL_ASSERT(len <= mmpkt->data_len);
|
||||
mmpkt->data_len = len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the `next` pointer embedded in the mmpkt.
|
||||
*
|
||||
* Used by the mmpkt_list structure for making linked lists of mmpkts.
|
||||
*
|
||||
* @param mmpkt The mmpkt to operate on.
|
||||
*
|
||||
* @returns pointer to the next mmpkt in the chain (may be NULL).
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_get_next(struct mmpkt *mmpkt)
|
||||
{
|
||||
return mmpkt->next;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the `next` pointer embedded in the mmpkt.
|
||||
*
|
||||
* Used by the mmpkt_list structure for making linked lists of mmpkts.
|
||||
*
|
||||
* @param mmpkt The mmpkt to operate on.
|
||||
* @param next The next mmpkt in the chain.
|
||||
*/
|
||||
static inline void mmpkt_set_next(struct mmpkt *mmpkt, struct mmpkt *next)
|
||||
{
|
||||
mmpkt->next = next;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check whether the given pointer is pointing inside the mmpkt's buffer.
|
||||
*
|
||||
* @note This checks against the full buffer, which includes any unused regions at the beginning and
|
||||
* end of the buffer which do not contain valid packet data.
|
||||
*
|
||||
* @param view The opened mmpkt to operate on.
|
||||
* @param ptr The pointer to check.
|
||||
*
|
||||
* @returns true if the pointer points into the buffer.
|
||||
*/
|
||||
static inline bool mmpkt_contains_ptr(struct mmpktview *view, const void *ptr)
|
||||
{
|
||||
struct mmpkt *mmpkt = (struct mmpkt *)view;
|
||||
return ((const uint8_t *)ptr >= &mmpkt->buf[0] && (const uint8_t *)ptr < &mmpkt->buf[mmpkt->buf_len]);
|
||||
}
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,172 @@
|
||||
/*
|
||||
* Copyright 2022-2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @ingroup MMPKT
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stddef.h>
|
||||
|
||||
#include "mmpkt.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** Structure that can be used as the head of a linked list of mmpkts that counts its length. */
|
||||
struct mmpkt_list {
|
||||
/** First mmpkt in the list. */
|
||||
struct mmpkt *volatile head;
|
||||
/** Last mmpkt in the list. */
|
||||
struct mmpkt *volatile tail;
|
||||
/** Length of the list. */
|
||||
volatile uint32_t len;
|
||||
};
|
||||
|
||||
/** Static initializer for @ref mmpkt_list. */
|
||||
#define MMPKT_LIST_INIT \
|
||||
{ \
|
||||
NULL, NULL, 0 \
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialization function for @ref mmpkt_list, for cases where @c MMPKT_LIST_INIT
|
||||
* cannot be used.
|
||||
*
|
||||
* @param list The mmpkt_list to init.
|
||||
*/
|
||||
static inline void mmpkt_list_init(struct mmpkt_list *list)
|
||||
{
|
||||
list->head = NULL;
|
||||
list->tail = NULL;
|
||||
list->len = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an mmpkt to the start of an mmpkt list.
|
||||
*
|
||||
* @param list The list to prepend to.
|
||||
* @param mmpkt The mmpkt to prepend.
|
||||
*/
|
||||
void mmpkt_list_prepend(struct mmpkt_list *list, struct mmpkt *mmpkt);
|
||||
|
||||
/**
|
||||
* Add an mmpkt to the end of an mmpkt list.
|
||||
*
|
||||
* @param list The list to append to.
|
||||
* @param mmpkt The mmpkt to append.
|
||||
*/
|
||||
void mmpkt_list_append(struct mmpkt_list *list, struct mmpkt *mmpkt);
|
||||
|
||||
/**
|
||||
* Remove an mmpkt from an mmpkt list.
|
||||
*
|
||||
* @param list The list to remove from.
|
||||
* @param mmpkt The mmpkt to remove.
|
||||
*/
|
||||
void mmpkt_list_remove(struct mmpkt_list *list, struct mmpkt *mmpkt);
|
||||
|
||||
/**
|
||||
* Remove the mmpkt at the head of the list and return it.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmpkt, or @c NULL if the list is empty.
|
||||
*/
|
||||
struct mmpkt *mmpkt_list_dequeue(struct mmpkt_list *list);
|
||||
|
||||
/**
|
||||
* Remove the mmpkt at the tail of the list and return it.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmpkt, or @c NULL if the list is empty.
|
||||
*/
|
||||
struct mmpkt *mmpkt_list_dequeue_tail(struct mmpkt_list *list);
|
||||
|
||||
/**
|
||||
* Remove all mmpkts from the list and return as a linked list.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmpkts, or @c NULL if the list is empty.
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_list_dequeue_all(struct mmpkt_list *list)
|
||||
{
|
||||
struct mmpkt *head = list->head;
|
||||
list->head = NULL;
|
||||
list->tail = NULL;
|
||||
list->len = 0;
|
||||
return head;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the given mmpkt list is empty.
|
||||
*
|
||||
* @param list The list to check.
|
||||
*
|
||||
* @returns @c true if the list is empty, else @c false.
|
||||
*/
|
||||
static inline bool mmpkt_list_is_empty(struct mmpkt_list *list)
|
||||
{
|
||||
return (list->head == NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the head of the mmpkt list.
|
||||
*
|
||||
* @param list The list to peek into.
|
||||
*
|
||||
* @returns the mmpkt at the head of the list.
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_list_peek(struct mmpkt_list *list)
|
||||
{
|
||||
return list->head;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the tail of the mmpkt list.
|
||||
*
|
||||
* @param list The list to peek into.
|
||||
*
|
||||
* @returns the mmpkt at the tail of the list.
|
||||
*/
|
||||
static inline struct mmpkt *mmpkt_list_peek_tail(struct mmpkt_list *list)
|
||||
{
|
||||
return list->tail;
|
||||
}
|
||||
|
||||
/**
|
||||
* Free all the packets in the given list and reset the list to empty state.
|
||||
*
|
||||
* @param list The list to clear.
|
||||
*/
|
||||
void mmpkt_list_clear(struct mmpkt_list *list);
|
||||
|
||||
/**
|
||||
* Safely walk the mmpkt list.
|
||||
*
|
||||
* @warning This macro cannot be used following an if statement with no parentheses if there
|
||||
* is an else clause. For example, do not do:
|
||||
* `if (x) MMPKT_LIST_WALK(a,b,c) else foo();` -- instead:
|
||||
* `if (x) { MMPKT_LIST_WALK(a,b,c) } else foo();`
|
||||
*/
|
||||
#define MMPKT_LIST_WALK(_lst, _wlk, _nxt) \
|
||||
if ((_lst)->head != NULL) /* NOLINT(readability/braces) */ \
|
||||
for (_wlk = (_lst)->head, _nxt = mmpkt_get_next(_wlk); _wlk != NULL; \
|
||||
_wlk = _nxt, _nxt = _wlk ? mmpkt_get_next(_wlk) : NULL)
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @}
|
||||
*/
|
||||
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,302 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2022-2023 Morse Micro
|
||||
*/
|
||||
/**
|
||||
* @ingroup MMWLAN_REGDB
|
||||
* @defgroup MMWLAN_REGDB_TEMPLATE Template S1G regulatory database
|
||||
*
|
||||
* \{
|
||||
*
|
||||
* @section MMWLAN_REGDB_TEMPLATE_DISCLAIMER Disclaimer
|
||||
*
|
||||
* While every effort has been made to maintain accuracy of this database, no guarantee is
|
||||
* given as to the accuracy of the information contained herein.
|
||||
*
|
||||
* @section MMWLAN_REGDB_TEMPLATE_COUNTRIES Country code list
|
||||
*
|
||||
* | Country Code | Country |
|
||||
* | ------------ | ------- |
|
||||
* | AU | Australia |
|
||||
* | EU | EU |
|
||||
* | IN | India |
|
||||
* | JP | Japan |
|
||||
* | KR | South Korea |
|
||||
* | NZ | New Zealand |
|
||||
* | SG | Singapore |
|
||||
* | US | USA |
|
||||
*/
|
||||
|
||||
#include "mmwlan.h"
|
||||
|
||||
/** List of valid S1G channels for Australia. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_AU[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 915500000, 10000, false, 68, 22, 27, 1, 30, 0, 0, 0 },
|
||||
{ 916500000, 10000, false, 68, 22, 29, 1, 30, 0, 0, 0 },
|
||||
{ 917500000, 10000, false, 68, 22, 31, 1, 30, 0, 0, 0 },
|
||||
{ 918500000, 10000, false, 68, 22, 33, 1, 30, 0, 0, 0 },
|
||||
{ 919500000, 10000, false, 68, 22, 35, 1, 30, 0, 0, 0 },
|
||||
{ 920500000, 10000, false, 68, 22, 37, 1, 30, 0, 0, 0 },
|
||||
{ 921500000, 10000, false, 68, 22, 39, 1, 30, 0, 0, 0 },
|
||||
{ 922500000, 10000, false, 68, 22, 41, 1, 30, 0, 0, 0 },
|
||||
{ 923500000, 10000, false, 68, 22, 43, 1, 30, 0, 0, 0 },
|
||||
{ 924500000, 10000, false, 68, 22, 45, 1, 30, 0, 0, 0 },
|
||||
{ 925500000, 10000, false, 68, 22, 47, 1, 30, 0, 0, 0 },
|
||||
{ 926500000, 10000, false, 68, 22, 49, 1, 30, 0, 0, 0 },
|
||||
{ 927500000, 10000, false, 68, 22, 51, 1, 30, 0, 0, 0 },
|
||||
{ 917000000, 10000, false, 69, 23, 30, 2, 30, 0, 0, 0 },
|
||||
{ 919000000, 10000, false, 69, 23, 34, 2, 30, 0, 0, 0 },
|
||||
{ 921000000, 10000, false, 69, 23, 38, 2, 30, 0, 0, 0 },
|
||||
{ 923000000, 10000, false, 69, 23, 42, 2, 30, 0, 0, 0 },
|
||||
{ 925000000, 10000, false, 69, 23, 46, 2, 30, 0, 0, 0 },
|
||||
{ 927000000, 10000, false, 69, 23, 50, 2, 30, 0, 0, 0 },
|
||||
{ 918000000, 10000, false, 70, 24, 32, 4, 30, 0, 0, 0 },
|
||||
{ 922000000, 10000, false, 70, 24, 40, 4, 30, 0, 0, 0 },
|
||||
{ 926000000, 10000, false, 70, 24, 48, 4, 30, 0, 0, 0 },
|
||||
{ 924000000, 10000, false, 71, 25, 44, 8, 30, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for Australia. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_AU = {
|
||||
.country_code = "AU",
|
||||
.num_channels = (sizeof(s1g_channels_AU)/sizeof(s1g_channels_AU[0])),
|
||||
.channels = s1g_channels_AU,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for EU. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_EU[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 863500000, 280, false, 66, 6, 1, 1, 16, 0, 0, 0 },
|
||||
{ 864500000, 280, false, 66, 6, 3, 1, 16, 0, 0, 0 },
|
||||
{ 865500000, 280, false, 66, 6, 5, 1, 16, 0, 0, 0 },
|
||||
{ 866500000, 280, false, 66, 6, 7, 1, 16, 0, 0, 0 },
|
||||
{ 867500000, 280, false, 66, 6, 9, 1, 16, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for EU. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_EU = {
|
||||
.country_code = "EU",
|
||||
.num_channels = (sizeof(s1g_channels_EU)/sizeof(s1g_channels_EU[0])),
|
||||
.channels = s1g_channels_EU,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for India. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_IN[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 865500000, 280, false, 66, 6, 5, 1, 16, 0, 0, 0 },
|
||||
{ 866500000, 280, false, 66, 6, 7, 1, 16, 0, 0, 0 },
|
||||
{ 867500000, 280, false, 66, 6, 9, 1, 16, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for India. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_IN = {
|
||||
.country_code = "IN",
|
||||
.num_channels = (sizeof(s1g_channels_IN)/sizeof(s1g_channels_IN[0])),
|
||||
.channels = s1g_channels_IN,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for Japan. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_JP[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 921000000, 1000, true, 73, 8, 9, 1, 16, 2000, 2000, 100000 },
|
||||
{ 923000000, 1000, true, 73, 8, 13, 1, 16, 2000, 2000, 100000 },
|
||||
{ 924000000, 1000, true, 73, 8, 15, 1, 16, 2000, 2000, 100000 },
|
||||
{ 925000000, 1000, true, 73, 8, 17, 1, 16, 2000, 2000, 100000 },
|
||||
{ 926000000, 1000, true, 73, 8, 19, 1, 16, 2000, 2000, 100000 },
|
||||
{ 927000000, 1000, true, 73, 8, 21, 1, 16, 2000, 2000, 100000 },
|
||||
{ 923500000, 1000, true, 64, 9, 2, 2, 16, 2000, 2000, 100000 },
|
||||
{ 924500000, 1000, true, 64, 10, 4, 2, 16, 2000, 2000, 100000 },
|
||||
{ 925500000, 1000, true, 64, 9, 6, 2, 16, 2000, 2000, 100000 },
|
||||
{ 926500000, 1000, true, 64, 10, 8, 2, 16, 2000, 2000, 100000 },
|
||||
{ 924500000, 1000, true, 65, 11, 36, 4, 16, 2000, 2000, 100000 },
|
||||
{ 925500000, 1000, true, 65, 12, 38, 4, 16, 2000, 2000, 100000 },
|
||||
};
|
||||
|
||||
/** Channel list structure for Japan. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_JP = {
|
||||
.country_code = "JP",
|
||||
.num_channels = (sizeof(s1g_channels_JP)/sizeof(s1g_channels_JP[0])),
|
||||
.channels = s1g_channels_JP,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for South Korea. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_KR[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 918000000, 10000, false, 74, 14, 1, 1, 4, 50000, 0, 4000000 },
|
||||
{ 919000000, 10000, false, 74, 14, 3, 1, 4, 50000, 0, 4000000 },
|
||||
{ 920000000, 10000, false, 74, 14, 5, 1, 4, 50000, 0, 4000000 },
|
||||
{ 921000000, 10000, false, 74, 14, 7, 1, 4, 50000, 0, 4000000 },
|
||||
{ 922000000, 10000, false, 74, 14, 9, 1, 10, 50000, 0, 4000000 },
|
||||
{ 923000000, 10000, false, 74, 14, 11, 1, 10, 50000, 0, 4000000 },
|
||||
{ 918500000, 10000, false, 75, 15, 2, 2, 4, 50000, 0, 4000000 },
|
||||
{ 920500000, 10000, false, 75, 15, 6, 2, 4, 50000, 0, 4000000 },
|
||||
{ 922500000, 10000, false, 75, 15, 10, 2, 10, 50000, 0, 4000000 },
|
||||
{ 921500000, 10000, false, 76, 16, 8, 4, 4, 50000, 0, 4000000 },
|
||||
{ 926500000, 10000, false, 74, 14, 18, 1, 17, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 927500000, 10000, false, 74, 14, 20, 1, 17, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 928500000, 10000, false, 74, 14, 22, 1, 17, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 929500000, 10000, false, 74, 14, 24, 1, 17, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 927000000, 10000, false, 75, 15, 19, 2, 20, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 929000000, 10000, false, 75, 15, 23, 2, 20, 264, 0, 220000 }, /* Warning: regulatory requirements may not be met */
|
||||
};
|
||||
|
||||
/** Channel list structure for South Korea. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_KR = {
|
||||
.country_code = "KR",
|
||||
.num_channels = (sizeof(s1g_channels_KR)/sizeof(s1g_channels_KR[0])),
|
||||
.channels = s1g_channels_KR,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for New Zealand. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_NZ[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 915500000, 10000, false, 68, 26, 27, 1, 30, 0, 0, 0 },
|
||||
{ 916500000, 10000, false, 68, 26, 29, 1, 30, 0, 0, 0 },
|
||||
{ 917500000, 10000, false, 68, 26, 31, 1, 30, 0, 0, 0 },
|
||||
{ 918500000, 10000, false, 68, 26, 33, 1, 30, 0, 0, 0 },
|
||||
{ 919500000, 10000, false, 68, 26, 35, 1, 30, 0, 0, 0 },
|
||||
{ 920500000, 10000, false, 68, 26, 37, 1, 36, 0, 0, 0 },
|
||||
{ 921500000, 10000, false, 68, 26, 39, 1, 36, 0, 0, 0 },
|
||||
{ 922500000, 10000, false, 68, 26, 41, 1, 36, 0, 0, 0 },
|
||||
{ 923500000, 10000, false, 68, 26, 43, 1, 36, 0, 0, 0 },
|
||||
{ 924500000, 10000, false, 68, 26, 45, 1, 36, 0, 0, 0 },
|
||||
{ 925500000, 10000, false, 68, 26, 47, 1, 36, 0, 0, 0 },
|
||||
{ 926500000, 10000, false, 68, 26, 49, 1, 36, 0, 0, 0 },
|
||||
{ 927500000, 10000, false, 68, 26, 51, 1, 36, 0, 0, 0 },
|
||||
{ 917000000, 10000, false, 69, 27, 30, 2, 30, 0, 0, 0 },
|
||||
{ 919000000, 10000, false, 69, 27, 34, 2, 30, 0, 0, 0 },
|
||||
{ 921000000, 10000, false, 69, 27, 38, 2, 36, 0, 0, 0 },
|
||||
{ 923000000, 10000, false, 69, 27, 42, 2, 36, 0, 0, 0 },
|
||||
{ 925000000, 10000, false, 69, 27, 46, 2, 36, 0, 0, 0 },
|
||||
{ 927000000, 10000, false, 69, 27, 50, 2, 36, 0, 0, 0 },
|
||||
{ 918000000, 10000, false, 70, 28, 32, 4, 30, 0, 0, 0 },
|
||||
{ 922000000, 10000, false, 70, 28, 40, 4, 36, 0, 0, 0 },
|
||||
{ 926000000, 10000, false, 70, 28, 48, 4, 36, 0, 0, 0 },
|
||||
{ 924000000, 10000, false, 71, 29, 44, 8, 36, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for New Zealand. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_NZ = {
|
||||
.country_code = "NZ",
|
||||
.num_channels = (sizeof(s1g_channels_NZ)/sizeof(s1g_channels_NZ[0])),
|
||||
.channels = s1g_channels_NZ,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for Singapore. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_SG[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 866500000, 277, false, 66, 17, 7, 1, 29, 100000, 0, 1000000 },
|
||||
{ 867500000, 277, false, 66, 17, 9, 1, 29, 100000, 0, 1000000 },
|
||||
{ 868500000, 277, false, 66, 17, 11, 1, 29, 100000, 0, 1000000 },
|
||||
{ 868000000, 277, false, 67, 19, 10, 2, 29, 100000, 0, 1000000 },
|
||||
{ 920500000, 10000, false, 68, 18, 37, 1, 22, 0, 0, 0 },
|
||||
{ 921500000, 10000, false, 68, 18, 39, 1, 22, 0, 0, 0 },
|
||||
{ 922500000, 10000, false, 68, 18, 41, 1, 22, 0, 0, 0 },
|
||||
{ 923500000, 10000, false, 68, 18, 43, 1, 22, 0, 0, 0 },
|
||||
{ 924500000, 10000, false, 68, 18, 45, 1, 22, 0, 0, 0 },
|
||||
{ 921000000, 10000, false, 69, 20, 38, 2, 22, 0, 0, 0 },
|
||||
{ 923000000, 10000, false, 69, 20, 42, 2, 22, 0, 0, 0 },
|
||||
{ 922000000, 10000, false, 70, 21, 40, 4, 22, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for Singapore. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_SG = {
|
||||
.country_code = "SG",
|
||||
.num_channels = (sizeof(s1g_channels_SG)/sizeof(s1g_channels_SG[0])),
|
||||
.channels = s1g_channels_SG,
|
||||
};
|
||||
|
||||
/** List of valid S1G channels for USA. */
|
||||
static const struct mmwlan_s1g_channel s1g_channels_US[] = {
|
||||
/* Ctr Freq (Hz), Duty Cycle (%/100), Omit Control Response, Global Op Class, S1G Op Class, S1G Chan #, Op BW, Max Tx EIRP (dBm), Min Packet Spacing Window (microsec), airtime_min (microsec), airtime_max (microsec) */
|
||||
{ 902500000, 10000, false, 68, 1, 1, 1, 36, 0, 0, 0 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 903500000, 10000, false, 68, 1, 3, 1, 36, 0, 0, 0 },
|
||||
{ 904500000, 10000, false, 68, 1, 5, 1, 36, 0, 0, 0 },
|
||||
{ 905500000, 10000, false, 68, 1, 7, 1, 36, 0, 0, 0 },
|
||||
{ 906500000, 10000, false, 68, 1, 9, 1, 36, 0, 0, 0 },
|
||||
{ 907500000, 10000, false, 68, 1, 11, 1, 36, 0, 0, 0 },
|
||||
{ 908500000, 10000, false, 68, 1, 13, 1, 36, 0, 0, 0 },
|
||||
{ 909500000, 10000, false, 68, 1, 15, 1, 36, 0, 0, 0 },
|
||||
{ 910500000, 10000, false, 68, 1, 17, 1, 36, 0, 0, 0 },
|
||||
{ 911500000, 10000, false, 68, 1, 19, 1, 36, 0, 0, 0 },
|
||||
{ 912500000, 10000, false, 68, 1, 21, 1, 36, 0, 0, 0 },
|
||||
{ 913500000, 10000, false, 68, 1, 23, 1, 36, 0, 0, 0 },
|
||||
{ 914500000, 10000, false, 68, 1, 25, 1, 36, 0, 0, 0 },
|
||||
{ 915500000, 10000, false, 68, 1, 27, 1, 36, 0, 0, 0 },
|
||||
{ 916500000, 10000, false, 68, 1, 29, 1, 36, 0, 0, 0 },
|
||||
{ 917500000, 10000, false, 68, 1, 31, 1, 36, 0, 0, 0 },
|
||||
{ 918500000, 10000, false, 68, 1, 33, 1, 36, 0, 0, 0 },
|
||||
{ 919500000, 10000, false, 68, 1, 35, 1, 36, 0, 0, 0 },
|
||||
{ 920500000, 10000, false, 68, 1, 37, 1, 36, 0, 0, 0 },
|
||||
{ 921500000, 10000, false, 68, 1, 39, 1, 36, 0, 0, 0 },
|
||||
{ 922500000, 10000, false, 68, 1, 41, 1, 36, 0, 0, 0 },
|
||||
{ 923500000, 10000, false, 68, 1, 43, 1, 36, 0, 0, 0 },
|
||||
{ 924500000, 10000, false, 68, 1, 45, 1, 36, 0, 0, 0 },
|
||||
{ 925500000, 10000, false, 68, 1, 47, 1, 36, 0, 0, 0 },
|
||||
{ 926500000, 10000, false, 68, 1, 49, 1, 36, 0, 0, 0 },
|
||||
{ 927500000, 10000, false, 68, 1, 51, 1, 36, 0, 0, 0 },
|
||||
{ 903000000, 10000, false, 69, 2, 2, 2, 36, 0, 0, 0 }, /* Warning: regulatory requirements may not be met */
|
||||
{ 905000000, 10000, false, 69, 2, 6, 2, 36, 0, 0, 0 },
|
||||
{ 907000000, 10000, false, 69, 2, 10, 2, 36, 0, 0, 0 },
|
||||
{ 909000000, 10000, false, 69, 2, 14, 2, 36, 0, 0, 0 },
|
||||
{ 911000000, 10000, false, 69, 2, 18, 2, 36, 0, 0, 0 },
|
||||
{ 913000000, 10000, false, 69, 2, 22, 2, 36, 0, 0, 0 },
|
||||
{ 915000000, 10000, false, 69, 2, 26, 2, 36, 0, 0, 0 },
|
||||
{ 917000000, 10000, false, 69, 2, 30, 2, 36, 0, 0, 0 },
|
||||
{ 919000000, 10000, false, 69, 2, 34, 2, 36, 0, 0, 0 },
|
||||
{ 921000000, 10000, false, 69, 2, 38, 2, 36, 0, 0, 0 },
|
||||
{ 923000000, 10000, false, 69, 2, 42, 2, 36, 0, 0, 0 },
|
||||
{ 925000000, 10000, false, 69, 2, 46, 2, 36, 0, 0, 0 },
|
||||
{ 927000000, 10000, false, 69, 2, 50, 2, 36, 0, 0, 0 },
|
||||
{ 906000000, 10000, false, 70, 3, 8, 4, 36, 0, 0, 0 },
|
||||
{ 910000000, 10000, false, 70, 3, 16, 4, 36, 0, 0, 0 },
|
||||
{ 914000000, 10000, false, 70, 3, 24, 4, 36, 0, 0, 0 },
|
||||
{ 918000000, 10000, false, 70, 3, 32, 4, 36, 0, 0, 0 },
|
||||
{ 922000000, 10000, false, 70, 3, 40, 4, 36, 0, 0, 0 },
|
||||
{ 926000000, 10000, false, 70, 3, 48, 4, 36, 0, 0, 0 },
|
||||
{ 908000000, 10000, false, 71, 4, 12, 8, 36, 0, 0, 0 },
|
||||
{ 916000000, 10000, false, 71, 4, 28, 8, 36, 0, 0, 0 },
|
||||
{ 924000000, 10000, false, 71, 4, 44, 8, 36, 0, 0, 0 },
|
||||
};
|
||||
|
||||
/** Channel list structure for USA. */
|
||||
static const struct mmwlan_s1g_channel_list s1g_channel_list_US = {
|
||||
.country_code = "US",
|
||||
.num_channels = (sizeof(s1g_channels_US)/sizeof(s1g_channels_US[0])),
|
||||
.channels = s1g_channels_US,
|
||||
};
|
||||
|
||||
/** Array of all channel list structs used for the regulatory database. */
|
||||
|
||||
static const struct mmwlan_s1g_channel_list *regulatory_db_domains[] = {
|
||||
&s1g_channel_list_AU,
|
||||
&s1g_channel_list_EU,
|
||||
&s1g_channel_list_IN,
|
||||
&s1g_channel_list_JP,
|
||||
&s1g_channel_list_KR,
|
||||
&s1g_channel_list_NZ,
|
||||
&s1g_channel_list_SG,
|
||||
&s1g_channel_list_US,
|
||||
};
|
||||
|
||||
/** Regulatory database. */
|
||||
static const struct mmwlan_regulatory_db regulatory_db = {
|
||||
.num_domains = (sizeof(regulatory_db_domains)/sizeof(regulatory_db_domains[0])),
|
||||
.domains = regulatory_db_domains,
|
||||
};
|
||||
|
||||
/**
|
||||
* Get a pointer to regulatory_db. This function isn't strictly necessary, since regulatory_db
|
||||
* can be accessed directly, but will prevent the compiler from generated warnings about
|
||||
* regulatory_db being unused.
|
||||
*
|
||||
* @return Reference to the regulatory database
|
||||
*/
|
||||
static inline const struct mmwlan_regulatory_db *get_regulatory_db(void)
|
||||
{
|
||||
return ®ulatory_db;
|
||||
}
|
||||
|
||||
|
||||
/** \} */
|
||||
Binary file not shown.
@@ -0,0 +1,14 @@
|
||||
{
|
||||
"name": "MorseWlan",
|
||||
"version": "0.1.0",
|
||||
"description": "Morse Micro mm-iot-esp32 SDK vendored for Meshtastic HaLow transport. Static morselib (Apache-2.0) + open-source shims.",
|
||||
"frameworks": ["arduino", "espidf"],
|
||||
"platforms": ["espressif32"],
|
||||
"build": {
|
||||
"srcDir": "src",
|
||||
"srcFilter": ["+<*.c>"],
|
||||
"includeDir": "include",
|
||||
"libArchive": false,
|
||||
"extraScript": "extra_script.py"
|
||||
}
|
||||
}
|
||||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -0,0 +1,148 @@
|
||||
/*
|
||||
* Copyright 2022-2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: BSD-3-Clause
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/*
|
||||
* ----
|
||||
* Endianness operations
|
||||
* ----
|
||||
*/
|
||||
|
||||
#ifdef __big_endian__
|
||||
#define __BYTE_ORDER __BIG_ENDIAN
|
||||
#else
|
||||
#define __BYTE_ORDER __LITTLE_ENDIAN
|
||||
#endif
|
||||
|
||||
#define bswap_16(x) __builtin_bswap16(x)
|
||||
#define bswap_32(x) __builtin_bswap32(x)
|
||||
|
||||
#define INET_ADDRSTRLEN 16
|
||||
#define INET6_ADDRSTRLEN 46
|
||||
|
||||
/* Protocol families. */
|
||||
#define PF_INET 2 /* IP protocol family. */
|
||||
#define PF_INET6 10 /* IP version 6. */
|
||||
|
||||
/* Address families. */
|
||||
#define AF_INET PF_INET
|
||||
#define AF_INET6 PF_INET6
|
||||
|
||||
/*
|
||||
* ----
|
||||
* Type definitions
|
||||
* ----
|
||||
*/
|
||||
typedef signed char __s8;
|
||||
typedef unsigned char __u8;
|
||||
typedef signed short __s16;
|
||||
typedef unsigned short __u16;
|
||||
typedef signed int __s32;
|
||||
typedef unsigned int __u32;
|
||||
|
||||
struct in_addr {
|
||||
__u32 s_addr;
|
||||
};
|
||||
|
||||
struct in6_addr {
|
||||
union {
|
||||
__u32 u32_addr[4];
|
||||
__u8 u8_addr[16];
|
||||
} un;
|
||||
#define s6_addr un.u8_addr
|
||||
};
|
||||
|
||||
/* Stub function declaration for inet_ntop which is called from write_ipv4_info
|
||||
* function in robust_av.c. Since they are not used we will create a dummy
|
||||
* function declarion here.
|
||||
*/
|
||||
const char *inet_ntop(int __af, const void *__cp, char *__buf, int __len);
|
||||
|
||||
/* Rename crypto functions to match symbol name mangling in morselib for avoidance of namespace
|
||||
* collisions. */
|
||||
#define aes_decrypt mmint_aes_decrypt
|
||||
#define aes_decrypt_deinit mmint_aes_decrypt_deinit
|
||||
#define aes_decrypt_init mmint_aes_decrypt_init
|
||||
#define crypto_bignum_add mmint_crypto_bignum_add
|
||||
#define crypto_bignum_addmod mmint_crypto_bignum_addmod
|
||||
#define crypto_bignum_cmp mmint_crypto_bignum_cmp
|
||||
#define crypto_bignum_deinit mmint_crypto_bignum_deinit
|
||||
#define crypto_bignum_div mmint_crypto_bignum_div
|
||||
#define crypto_bignum_exptmod mmint_crypto_bignum_exptmod
|
||||
#define crypto_bignum_init mmint_crypto_bignum_init
|
||||
#define crypto_bignum_init_set mmint_crypto_bignum_init_set
|
||||
#define crypto_bignum_init_uint mmint_crypto_bignum_init_uint
|
||||
#define crypto_bignum_inverse mmint_crypto_bignum_inverse
|
||||
#define crypto_bignum_is_odd mmint_crypto_bignum_is_odd
|
||||
#define crypto_bignum_is_one mmint_crypto_bignum_is_one
|
||||
#define crypto_bignum_is_zero mmint_crypto_bignum_is_zero
|
||||
#define crypto_bignum_legendre mmint_crypto_bignum_legendre
|
||||
#define crypto_bignum_mod mmint_crypto_bignum_mod
|
||||
#define crypto_bignum_mulmod mmint_crypto_bignum_mulmod
|
||||
#define crypto_bignum_rand mmint_crypto_bignum_rand
|
||||
#define crypto_bignum_rshift mmint_crypto_bignum_rshift
|
||||
#define crypto_bignum_sqrmod mmint_crypto_bignum_sqrmod
|
||||
#define crypto_bignum_sub mmint_crypto_bignum_sub
|
||||
#define crypto_bignum_to_bin mmint_crypto_bignum_to_bin
|
||||
#define crypto_ec_deinit mmint_crypto_ec_deinit
|
||||
#define crypto_ec_get_a mmint_crypto_ec_get_a
|
||||
#define crypto_ec_get_b mmint_crypto_ec_get_b
|
||||
#define crypto_ec_get_generator mmint_crypto_ec_get_generator
|
||||
#define crypto_ec_get_order mmint_crypto_ec_get_order
|
||||
#define crypto_ec_get_prime mmint_crypto_ec_get_prime
|
||||
#define crypto_ec_init mmint_crypto_ec_init
|
||||
#define crypto_ec_order_len mmint_crypto_ec_order_len
|
||||
#define crypto_ec_point_add mmint_crypto_ec_point_add
|
||||
#define crypto_ec_point_cmp mmint_crypto_ec_point_cmp
|
||||
#define crypto_ec_point_x mmint_crypto_ec_point_x
|
||||
#define crypto_ec_point_compute_y_sqr mmint_crypto_ec_point_compute_y_sqr
|
||||
#define crypto_ec_point_deinit mmint_crypto_ec_point_deinit
|
||||
#define crypto_ec_point_from_bin mmint_crypto_ec_point_from_bin
|
||||
#define crypto_ec_point_init mmint_crypto_ec_point_init
|
||||
#define crypto_ec_point_invert mmint_crypto_ec_point_invert
|
||||
#define crypto_ec_point_is_at_infinity mmint_crypto_ec_point_is_at_infinity
|
||||
#define crypto_ec_point_is_on_curve mmint_crypto_ec_point_is_on_curve
|
||||
#define crypto_ec_point_mul mmint_crypto_ec_point_mul
|
||||
#define crypto_ec_point_to_bin mmint_crypto_ec_point_to_bin
|
||||
#define crypto_ec_prime_len mmint_crypto_ec_prime_len
|
||||
#define crypto_ec_prime_len_bits mmint_crypto_ec_prime_len_bits
|
||||
#define crypto_ecdh_deinit mmint_crypto_ecdh_deinit
|
||||
#define crypto_ecdh_get_pubkey mmint_crypto_ecdh_get_pubkey
|
||||
#define crypto_ecdh_init mmint_crypto_ecdh_init
|
||||
#define crypto_ecdh_init2 mmint_crypto_ecdh_init2
|
||||
#define crypto_ecdh_set_peerkey mmint_crypto_ecdh_set_peerkey
|
||||
#define crypto_ecdh_prime_len mmint_crypto_ecdh_prime_len
|
||||
#define crypto_get_random mmint_crypto_get_random
|
||||
#define crypto_unload mmint_crypto_unload
|
||||
#define hmac_md5 mmint_hmac_md5
|
||||
#define hmac_sha1 mmint_hmac_sha1
|
||||
#define hmac_sha1_vector mmint_hmac_sha1_vector
|
||||
#define hmac_sha256 mmint_hmac_sha256
|
||||
#define hmac_sha256_vector mmint_hmac_sha256_vector
|
||||
#define hmac_sha384 mmint_hmac_sha384
|
||||
#define hmac_sha384_vector mmint_hmac_sha384_vector
|
||||
#define hmac_sha512 mmint_hmac_sha512
|
||||
#define hmac_sha512_vector mmint_hmac_sha512_vector
|
||||
#define omac1_aes_vector mmint_omac1_aes_vector
|
||||
#define omac1_aes_128 mmint_omac1_aes_128
|
||||
#define pbkdf2_sha1 mmint_pbkdf2_sha1
|
||||
#define sha1_prf mmint_sha1_prf
|
||||
#define sha1_vector mmint_sha1_vector
|
||||
#define sha256_prf mmint_sha256_prf
|
||||
#define sha256_prf_bits mmint_sha256_prf_bits
|
||||
#define sha256_vector mmint_sha256_vector
|
||||
#define sha384_prf mmint_sha384_prf
|
||||
#define sha384_vector mmint_sha384_vector
|
||||
#define sha512_prf mmint_sha512_prf
|
||||
#define sha512_vector mmint_sha512_vector
|
||||
|
||||
#define wpabuf_alloc mmint_wpabuf_alloc
|
||||
#define wpabuf_alloc_copy mmint_wpabuf_alloc_copy
|
||||
#define wpabuf_clear_free mmint_wpabuf_clear_free
|
||||
#define wpabuf_put mmint_wpabuf_put
|
||||
@@ -0,0 +1,27 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Stubs for LWIP netif callback API that Arduino-ESP32's prebuilt LWIP omits
|
||||
* (CONFIG_LWIP_NETIF_STATUS_CALLBACK / _LINK_CALLBACK are disabled in its
|
||||
* sdkconfig, so the real functions are absent from the static library).
|
||||
*
|
||||
* mmipal calls these once during init to register a single callback for
|
||||
* link-up / IP-configured events. With these stubs, the callback never fires —
|
||||
* mmwlan_register_link_state_cb (driven by the radio firmware) remains the
|
||||
* authoritative source of link state, so this only costs us LWIP-level
|
||||
* notifications (e.g. "DHCP got an address"). HaLowInterface polls
|
||||
* mmipal_get_ip_config when it needs to know.
|
||||
*/
|
||||
#include "lwip/netif.h"
|
||||
|
||||
void __attribute__((weak)) netif_set_link_callback(struct netif *netif, netif_status_callback_fn link_callback)
|
||||
{
|
||||
(void)netif;
|
||||
(void)link_callback;
|
||||
}
|
||||
|
||||
void __attribute__((weak)) netif_set_status_callback(struct netif *netif, netif_status_callback_fn status_callback)
|
||||
{
|
||||
(void)netif;
|
||||
(void)status_callback;
|
||||
}
|
||||
#endif
|
||||
Binary file not shown.
@@ -0,0 +1,216 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*
|
||||
*/
|
||||
|
||||
#include "mmbuf.h"
|
||||
#include "mmosal.h"
|
||||
#include "mmutils.h"
|
||||
|
||||
static const struct mmbuf_ops mmbuf_heap_ops = {.free_mmbuf = mmosal_free};
|
||||
|
||||
struct mmbuf *mmbuf_alloc_on_heap(uint32_t space_at_start, uint32_t space_at_end)
|
||||
{
|
||||
struct mmbuf *mmbuf;
|
||||
uint8_t *buf;
|
||||
uint32_t alloc_len = MM_FAST_ROUND_UP(sizeof(*mmbuf), 4) + MM_FAST_ROUND_UP(space_at_start + space_at_end, 4);
|
||||
mmbuf = (struct mmbuf *)mmosal_malloc(alloc_len);
|
||||
if (mmbuf == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* We zero the buffer as a defensive measure to reduce the likelihood of unintentionally
|
||||
* leaking information. */
|
||||
memset((uint8_t *)mmbuf, 0, alloc_len);
|
||||
|
||||
buf = ((uint8_t *)mmbuf) + MM_FAST_ROUND_UP(sizeof(*mmbuf), 4);
|
||||
|
||||
mmbuf_init(mmbuf, buf, MM_FAST_ROUND_UP(space_at_start + space_at_end, 4), space_at_start, &mmbuf_heap_ops);
|
||||
|
||||
return mmbuf;
|
||||
}
|
||||
|
||||
struct mmbuf *mmbuf_make_copy_on_heap(struct mmbuf *original)
|
||||
{
|
||||
struct mmbuf *mmbuf;
|
||||
uint8_t *buf;
|
||||
uint32_t alloc_len = MM_FAST_ROUND_UP(sizeof(*original), 4) + original->buf_len;
|
||||
mmbuf = (struct mmbuf *)mmosal_malloc(alloc_len);
|
||||
if (mmbuf == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
buf = ((uint8_t *)mmbuf) + MM_FAST_ROUND_UP(sizeof(*mmbuf), 4);
|
||||
mmbuf_init(mmbuf, buf, original->buf_len, original->start_offset, &mmbuf_heap_ops);
|
||||
mmbuf->data_len = original->data_len;
|
||||
|
||||
if (original->data_len) {
|
||||
memcpy(mmbuf_get_data_start(mmbuf), mmbuf_get_data_start(original), mmbuf_get_data_length(original));
|
||||
}
|
||||
|
||||
return mmbuf;
|
||||
}
|
||||
|
||||
void mmbuf_release(struct mmbuf *mmbuf)
|
||||
{
|
||||
if (mmbuf == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
MMOSAL_ASSERT(mmbuf->ops != NULL && mmbuf->ops->free_mmbuf != NULL);
|
||||
mmbuf->ops->free_mmbuf(mmbuf);
|
||||
}
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
static void mmbuf_list_sanity_check(struct mmbuf_list *list)
|
||||
{
|
||||
unsigned cnt = 0;
|
||||
struct mmbuf *walk;
|
||||
struct mmbuf *prev = NULL;
|
||||
|
||||
for (walk = list->head; walk != NULL; walk = walk->next) {
|
||||
cnt++;
|
||||
prev = walk;
|
||||
}
|
||||
|
||||
MMOSAL_ASSERT(cnt == list->len);
|
||||
MMOSAL_ASSERT(prev == list->tail);
|
||||
}
|
||||
#endif
|
||||
|
||||
void mmbuf_list_prepend(struct mmbuf_list *list, struct mmbuf *mmbuf)
|
||||
{
|
||||
mmbuf->next = list->head;
|
||||
list->head = mmbuf;
|
||||
list->len++;
|
||||
|
||||
if (list->tail == NULL) {
|
||||
list->tail = list->head;
|
||||
}
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
mmbuf_list_sanity_check(list);
|
||||
#endif
|
||||
}
|
||||
|
||||
void mmbuf_list_append(struct mmbuf_list *list, struct mmbuf *mmbuf)
|
||||
{
|
||||
mmbuf->next = NULL;
|
||||
if (list->head == NULL) {
|
||||
list->head = mmbuf;
|
||||
list->tail = mmbuf;
|
||||
} else {
|
||||
list->tail->next = mmbuf;
|
||||
list->tail = mmbuf;
|
||||
}
|
||||
list->len++;
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
mmbuf_list_sanity_check(list);
|
||||
#endif
|
||||
}
|
||||
|
||||
static struct mmbuf *mmbuf_find_prev(struct mmbuf_list *list, struct mmbuf *mmbuf)
|
||||
{
|
||||
struct mmbuf *walk, *next;
|
||||
for (walk = list->head, next = walk->next; next != NULL; walk = next, next = walk->next) {
|
||||
if (next == mmbuf) {
|
||||
return walk;
|
||||
}
|
||||
}
|
||||
return NULL;
|
||||
}
|
||||
|
||||
bool mmbuf_list_remove(struct mmbuf_list *list, struct mmbuf *mmbuf)
|
||||
{
|
||||
struct mmbuf *prev = NULL;
|
||||
|
||||
if (list->head == NULL) {
|
||||
return false;
|
||||
}
|
||||
|
||||
if (list->head == mmbuf) {
|
||||
list->head = mmbuf->next;
|
||||
} else {
|
||||
prev = mmbuf_find_prev(list, mmbuf);
|
||||
if (prev == NULL) {
|
||||
return false;
|
||||
}
|
||||
prev->next = mmbuf->next;
|
||||
}
|
||||
|
||||
if (list->tail == mmbuf) {
|
||||
list->tail = prev;
|
||||
}
|
||||
|
||||
list->len--;
|
||||
mmbuf->next = NULL;
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
mmbuf_list_sanity_check(list);
|
||||
#endif
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
struct mmbuf *mmbuf_list_dequeue(struct mmbuf_list *list)
|
||||
{
|
||||
if (list->head == NULL) {
|
||||
return NULL;
|
||||
} else {
|
||||
struct mmbuf *mmbuf = list->head;
|
||||
list->head = mmbuf->next;
|
||||
list->len--;
|
||||
|
||||
if (list->tail == mmbuf) {
|
||||
list->tail = NULL;
|
||||
}
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
mmbuf_list_sanity_check(list);
|
||||
#endif
|
||||
if (mmbuf != NULL) {
|
||||
mmbuf->next = NULL;
|
||||
}
|
||||
return mmbuf;
|
||||
}
|
||||
}
|
||||
|
||||
struct mmbuf *mmbuf_list_dequeue_tail(struct mmbuf_list *list)
|
||||
{
|
||||
if (list->tail == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
struct mmbuf *mmbuf = list->tail;
|
||||
mmbuf_list_remove(list, mmbuf);
|
||||
|
||||
return mmbuf;
|
||||
}
|
||||
|
||||
void mmbuf_list_clear(struct mmbuf_list *list)
|
||||
{
|
||||
struct mmbuf *walk;
|
||||
struct mmbuf *next;
|
||||
|
||||
#ifdef MMBUF_SANITY
|
||||
mmbuf_list_sanity_check(list);
|
||||
#endif
|
||||
|
||||
if (list->head == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
for (walk = list->head, next = walk->next; walk != NULL; walk = next, next = walk ? walk->next : NULL) {
|
||||
mmbuf_release(walk);
|
||||
}
|
||||
|
||||
list->len = 0;
|
||||
list->head = NULL;
|
||||
list->tail = NULL;
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,457 @@
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMBUF Morse Micro Buffer (mmbuf) API
|
||||
*
|
||||
* This API provides support for buffers tailored towards packet-like data that has
|
||||
* headers and trailers that are applied at subsequent layers.
|
||||
*
|
||||
* It is designed to support various backends for memory allocation. The default
|
||||
* is allocation on the heap, but other methods could be used due to the flexible API.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdbool.h>
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "mmosal.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
struct mmbuf_ops;
|
||||
|
||||
/**
|
||||
* Core mmbuf data structure.
|
||||
*
|
||||
* @note The contents of this data structure should never need to be accessed directly. Rather
|
||||
* the various functions provided as part of this API should be used.
|
||||
*
|
||||
* @code
|
||||
* +----------------------------------------------------------+
|
||||
* | RESERVED | Data | RESERVED |
|
||||
* +----------------------------------------------------------+
|
||||
* ^ ^ ^ ^
|
||||
* | | | |
|
||||
* | |<-----------data_len--------->| |
|
||||
* | start_offset |
|
||||
* | |
|
||||
* |<-----------------------buf_len-------------------------->|
|
||||
* buf
|
||||
* @endcode
|
||||
*/
|
||||
struct mmbuf {
|
||||
/** The buffer where data is stored. */
|
||||
uint8_t *buf;
|
||||
/** Length of the buffer. */
|
||||
uint32_t buf_len;
|
||||
/** Offset where actual data starts in the buffer. */
|
||||
uint32_t start_offset;
|
||||
/** Length of actual data in the buffer. */
|
||||
uint32_t data_len;
|
||||
/** Reference to operations data structure for this mmbuf. */
|
||||
const struct mmbuf_ops *ops;
|
||||
/** Pointer that can be used to construct linked lists. */
|
||||
struct mmbuf *volatile next;
|
||||
};
|
||||
|
||||
/** Operations data structure for mmbuf. */
|
||||
struct mmbuf_ops {
|
||||
/** Free the given mmbuf. */
|
||||
void (*free_mmbuf)(void *mmbuf);
|
||||
};
|
||||
|
||||
/**
|
||||
* Initialize an mmbuf header with the given values.
|
||||
*
|
||||
* @param mmbuf mmbuf to initialize.
|
||||
* @param buf Pointer to buffer.
|
||||
* @param buf_len Length of @p buf.
|
||||
* @param data_start_offset Initial value for @c start_offset.
|
||||
* @param ops Operations data structure.
|
||||
*/
|
||||
static inline void mmbuf_init(struct mmbuf *mmbuf, uint8_t *buf, uint32_t buf_len, uint32_t data_start_offset,
|
||||
const struct mmbuf_ops *ops)
|
||||
{
|
||||
memset(mmbuf, 0, sizeof(*mmbuf));
|
||||
mmbuf->buf = buf;
|
||||
mmbuf->buf_len = buf_len;
|
||||
mmbuf->start_offset = data_start_offset;
|
||||
mmbuf->ops = ops;
|
||||
}
|
||||
|
||||
/**
|
||||
* Allocate a new mmbuf on the heap (using @ref mmosal_malloc()).
|
||||
*
|
||||
* @param space_at_start Amount of space to reserve at start of buffer.
|
||||
* @param space_at_end Amount of space to reserve at end of buffer.
|
||||
*
|
||||
* @note @c start_offset will be set to @p space_at_start, and @c buf_len will be the sum
|
||||
* of @p space_at_start and @p space_at_end (rounded up to a multiple of 4).
|
||||
*
|
||||
* @returns newly allocated mmbuf on success or @c NULL on failure.
|
||||
*/
|
||||
struct mmbuf *mmbuf_alloc_on_heap(uint32_t space_at_start, uint32_t space_at_end);
|
||||
|
||||
/**
|
||||
* Make a copy of the given mmbuf. Note that regardless of the backend that allocated
|
||||
* @p original, the newly allocated mmbuf will be allocated on the heap using
|
||||
* @ref mmbuf_alloc_on_heap().
|
||||
*
|
||||
* @param original mmbuf to copy.
|
||||
*
|
||||
* @returns newly allocated mmbuf on success or @c NULL on failure.
|
||||
*/
|
||||
struct mmbuf *mmbuf_make_copy_on_heap(struct mmbuf *original);
|
||||
|
||||
/**
|
||||
* Release a reference to the given mmbuf. If this was the last reference (@c addition_ref_cnt
|
||||
* was 0) then the mmbuf will be freed using the appropriate op callback.
|
||||
*
|
||||
* @param mmbuf The mmbuf to release reference to. May be @c NULL.
|
||||
*/
|
||||
void mmbuf_release(struct mmbuf *mmbuf);
|
||||
|
||||
/**
|
||||
* Gets a pointer to the start of the data in the mmbuf.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
*
|
||||
* @returns a pointer to the start of the data in the mmbuf.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_get_data_start(struct mmbuf *mmbuf)
|
||||
{
|
||||
return mmbuf->buf + mmbuf->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a pointer to the end of the data in the mmbuf.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
*
|
||||
* @returns a pointer to the end of the data in the mmbuf.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_get_data_end(struct mmbuf *mmbuf)
|
||||
{
|
||||
return mmbuf->buf + mmbuf->start_offset + mmbuf->data_len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the length of the data currently in the mmbuf.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
*
|
||||
* @returns the length of the data currently in the mmbuf (note that this is different from the
|
||||
* length of the available buffer space).
|
||||
*/
|
||||
static inline uint32_t mmbuf_get_data_length(struct mmbuf *mmbuf)
|
||||
{
|
||||
return mmbuf->data_len;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the amount of space available for prepending to the data in the buffer.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
*
|
||||
* @returns the available space in bytes.
|
||||
*/
|
||||
static inline uint32_t mmbuf_available_space_at_start(struct mmbuf *mmbuf)
|
||||
{
|
||||
return mmbuf->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the amount of space available for appending to the data in the buffer.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
*
|
||||
* @returns the available space in bytes.
|
||||
*/
|
||||
static inline uint32_t mmbuf_available_space_at_end(struct mmbuf *mmbuf)
|
||||
{
|
||||
return mmbuf->buf_len - (mmbuf->start_offset + mmbuf->data_len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reserves space immediately before the data currently in the given mmbuf and returns
|
||||
* a pointer to this space.
|
||||
*
|
||||
* For a function that also copies data in, see @ref mmbuf_prepend_data().
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmbuf_available_space_at_start().
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
* @param len Length of data to be prepended.
|
||||
*
|
||||
* @returns a pointer to the place in the buffer where the data should be put.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_prepend(struct mmbuf *mmbuf, uint32_t len)
|
||||
{
|
||||
MMOSAL_ASSERT(len <= mmbuf_available_space_at_start(mmbuf));
|
||||
mmbuf->start_offset -= len;
|
||||
mmbuf->data_len += len;
|
||||
return mmbuf->buf + mmbuf->start_offset;
|
||||
}
|
||||
|
||||
/**
|
||||
* Prepends the given data to the data already in the mmbuf.
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmbuf_available_space_at_start().
|
||||
*
|
||||
* @warning The memory area pointed to by data must not overlap with the mmbuf data.
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
* @param data The data to be prepended.
|
||||
* @param len Length of data to be prepended.
|
||||
*/
|
||||
static inline void mmbuf_prepend_data(struct mmbuf *mmbuf, const uint8_t *data, uint32_t len)
|
||||
{
|
||||
uint8_t *dest = mmbuf_prepend(mmbuf, len);
|
||||
memcpy(dest, data, len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Reserves space immediately after the data currently in the given mmbuf and returns
|
||||
* a pointer to this space.
|
||||
*
|
||||
* For a function that also copies data in, see @ref mmbuf_append_data().
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmbuf_available_space_at_end().
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
* @param len Length of data to be append.
|
||||
*
|
||||
* @returns a pointer to the place in the buffer where the data should be put.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_append(struct mmbuf *mmbuf, uint32_t len)
|
||||
{
|
||||
uint8_t *ret = mmbuf_get_data_end(mmbuf);
|
||||
MMOSAL_ASSERT(len <= mmbuf_available_space_at_end(mmbuf));
|
||||
mmbuf->data_len += len;
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Appends the given data to the data already in the mmbuf.
|
||||
*
|
||||
* @warning @p len must be less than or equal to @ref mmbuf_available_space_at_start().
|
||||
*
|
||||
* @param mmbuf The mmbuf to operate on.
|
||||
* @param data The data to be prepended.
|
||||
* @param len Length of data to be prepended.
|
||||
*/
|
||||
static inline void mmbuf_append_data(struct mmbuf *mmbuf, const uint8_t *data, uint32_t len)
|
||||
{
|
||||
uint8_t *dest = mmbuf_append(mmbuf, len);
|
||||
memcpy(dest, data, len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove data from the start of the mmbuf.
|
||||
*
|
||||
* @param mmbuf mmbuf to operate on.
|
||||
* @param len Length of data to remove.
|
||||
*
|
||||
* @returns a pointer to the removed data or NULL if the mmbuf data length was less than @p len.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_remove_from_start(struct mmbuf *mmbuf, uint32_t len)
|
||||
{
|
||||
uint8_t *ret;
|
||||
|
||||
if (mmbuf_get_data_length(mmbuf) < len) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
ret = mmbuf_get_data_start(mmbuf);
|
||||
|
||||
mmbuf->start_offset += len;
|
||||
mmbuf->data_len -= len;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove data from the end of the mmbuf.
|
||||
*
|
||||
* @param mmbuf mmbuf to operate on.
|
||||
* @param len Length of data to remove.
|
||||
*
|
||||
* @returns a pointer to the removed data or NULL if the mmbuf data length was less than @p len.
|
||||
*/
|
||||
static inline uint8_t *mmbuf_remove_from_end(struct mmbuf *mmbuf, uint32_t len)
|
||||
{
|
||||
uint8_t *ret;
|
||||
|
||||
if (mmbuf_get_data_length(mmbuf) < len) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
ret = mmbuf_get_data_end(mmbuf) - len;
|
||||
|
||||
mmbuf->data_len -= len;
|
||||
|
||||
return ret;
|
||||
}
|
||||
|
||||
/**
|
||||
* Truncate the mmbuf data to the given length.
|
||||
*
|
||||
* @param mmbuf mmbuf to operate on.
|
||||
* @param len New data length. (Must be less than or equal to the data length
|
||||
* of the mmbuf).
|
||||
*/
|
||||
static inline void mmbuf_truncate(struct mmbuf *mmbuf, uint32_t len)
|
||||
{
|
||||
MMOSAL_ASSERT(len <= mmbuf->data_len);
|
||||
mmbuf->data_len = len;
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
/** Structure that can be used as the head of a linked list of mmbufs that counts its length. */
|
||||
struct mmbuf_list {
|
||||
/** First mmbuf in the list. */
|
||||
struct mmbuf *volatile head;
|
||||
/** Last mmbuf in the list. */
|
||||
struct mmbuf *volatile tail;
|
||||
/** Length of the list. */
|
||||
volatile uint32_t len;
|
||||
};
|
||||
|
||||
/** Static initializer for @ref mmbuf_list. */
|
||||
#define MMBUF_LIST_INIT \
|
||||
{ \
|
||||
NULL, NULL, 0 \
|
||||
}
|
||||
|
||||
/**
|
||||
* Initialization function for @ref mmbuf_list, for cases where @c MMBUF_LIST_INIT
|
||||
* cannot be used.
|
||||
*
|
||||
* @param list The mmbuf_list to init.
|
||||
*/
|
||||
static inline void mmbuf_list_init(struct mmbuf_list *list)
|
||||
{
|
||||
list->head = NULL;
|
||||
list->tail = NULL;
|
||||
list->len = 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Add an mmbuf to the start of an mmbuf list.
|
||||
*
|
||||
* @param list The list to prepend to.
|
||||
* @param mmbuf The mmbuf to prepend.
|
||||
*/
|
||||
void mmbuf_list_prepend(struct mmbuf_list *list, struct mmbuf *mmbuf);
|
||||
|
||||
/**
|
||||
* Add an mmbuf to the end of an mmbuf list.
|
||||
*
|
||||
* @param list The list to append to.
|
||||
* @param mmbuf The mmbuf to append.
|
||||
*/
|
||||
void mmbuf_list_append(struct mmbuf_list *list, struct mmbuf *mmbuf);
|
||||
|
||||
/**
|
||||
* Remove an mmbuf from an mmbuf list.
|
||||
*
|
||||
* @param list The list to remove from.
|
||||
* @param mmbuf The mmbuf to remove.
|
||||
*
|
||||
* @returns @c true if the given @c mmbuf was present in @c list, else @c fase.
|
||||
*/
|
||||
bool mmbuf_list_remove(struct mmbuf_list *list, struct mmbuf *mmbuf);
|
||||
|
||||
/**
|
||||
* Remove the mmbuf at the head of the list and return it.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmbuf, or @c NULL if the list is empty.
|
||||
*/
|
||||
struct mmbuf *mmbuf_list_dequeue(struct mmbuf_list *list);
|
||||
|
||||
/**
|
||||
* Remove the mmbuf at the tail of the list and return it.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmbuf, or @c NULL if the list is empty.
|
||||
*/
|
||||
struct mmbuf *mmbuf_list_dequeue_tail(struct mmbuf_list *list);
|
||||
|
||||
/**
|
||||
* Remove all mmbufs from the list and return as a linked list.
|
||||
*
|
||||
* @param list The list to dequeue from.
|
||||
*
|
||||
* @returns the dequeued mmbufs, or @c NULL if the list is empty.
|
||||
*/
|
||||
static inline struct mmbuf *mmbuf_list_dequeue_all(struct mmbuf_list *list)
|
||||
{
|
||||
struct mmbuf *head = list->head;
|
||||
list->head = NULL;
|
||||
list->tail = NULL;
|
||||
list->len = 0;
|
||||
return head;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks whether the given mmbuf list is empty.
|
||||
*
|
||||
* @param list The list to check.
|
||||
*
|
||||
* @returns @c true if the list is empty, else @c false.
|
||||
*/
|
||||
static inline bool mmbuf_list_is_empty(struct mmbuf_list *list)
|
||||
{
|
||||
return (list->head == NULL);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the head of the mmbuf list.
|
||||
*
|
||||
* @param list The list to peek into.
|
||||
*
|
||||
* @returns the mmbuf at the head of the list.
|
||||
*/
|
||||
static inline struct mmbuf *mmbuf_list_peek(struct mmbuf_list *list)
|
||||
{
|
||||
return list->head;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the tail of the mmbuf list.
|
||||
*
|
||||
* @param list The list to peek into.
|
||||
*
|
||||
* @returns the mmbuf at the tail of the list.
|
||||
*/
|
||||
static inline struct mmbuf *mmbuf_list_peek_tail(struct mmbuf_list *list)
|
||||
{
|
||||
return list->tail;
|
||||
}
|
||||
|
||||
/**
|
||||
* Free all the packets in the given list and reset the list to empty state.
|
||||
*
|
||||
* @param list The list to clear.
|
||||
*/
|
||||
void mmbuf_list_clear(struct mmbuf_list *list);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,50 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "mmcrc.h"
|
||||
|
||||
/**
|
||||
* Static table used for the table_driven implementation.
|
||||
*/
|
||||
static const uint16_t crc16_xmodem_lookup_table[256] = {
|
||||
0x0000, 0x1021, 0x2042, 0x3063, 0x4084, 0x50a5, 0x60c6, 0x70e7, 0x8108, 0x9129, 0xa14a, 0xb16b, 0xc18c, 0xd1ad, 0xe1ce,
|
||||
0xf1ef, 0x1231, 0x0210, 0x3273, 0x2252, 0x52b5, 0x4294, 0x72f7, 0x62d6, 0x9339, 0x8318, 0xb37b, 0xa35a, 0xd3bd, 0xc39c,
|
||||
0xf3ff, 0xe3de, 0x2462, 0x3443, 0x0420, 0x1401, 0x64e6, 0x74c7, 0x44a4, 0x5485, 0xa56a, 0xb54b, 0x8528, 0x9509, 0xe5ee,
|
||||
0xf5cf, 0xc5ac, 0xd58d, 0x3653, 0x2672, 0x1611, 0x0630, 0x76d7, 0x66f6, 0x5695, 0x46b4, 0xb75b, 0xa77a, 0x9719, 0x8738,
|
||||
0xf7df, 0xe7fe, 0xd79d, 0xc7bc, 0x48c4, 0x58e5, 0x6886, 0x78a7, 0x0840, 0x1861, 0x2802, 0x3823, 0xc9cc, 0xd9ed, 0xe98e,
|
||||
0xf9af, 0x8948, 0x9969, 0xa90a, 0xb92b, 0x5af5, 0x4ad4, 0x7ab7, 0x6a96, 0x1a71, 0x0a50, 0x3a33, 0x2a12, 0xdbfd, 0xcbdc,
|
||||
0xfbbf, 0xeb9e, 0x9b79, 0x8b58, 0xbb3b, 0xab1a, 0x6ca6, 0x7c87, 0x4ce4, 0x5cc5, 0x2c22, 0x3c03, 0x0c60, 0x1c41, 0xedae,
|
||||
0xfd8f, 0xcdec, 0xddcd, 0xad2a, 0xbd0b, 0x8d68, 0x9d49, 0x7e97, 0x6eb6, 0x5ed5, 0x4ef4, 0x3e13, 0x2e32, 0x1e51, 0x0e70,
|
||||
0xff9f, 0xefbe, 0xdfdd, 0xcffc, 0xbf1b, 0xaf3a, 0x9f59, 0x8f78, 0x9188, 0x81a9, 0xb1ca, 0xa1eb, 0xd10c, 0xc12d, 0xf14e,
|
||||
0xe16f, 0x1080, 0x00a1, 0x30c2, 0x20e3, 0x5004, 0x4025, 0x7046, 0x6067, 0x83b9, 0x9398, 0xa3fb, 0xb3da, 0xc33d, 0xd31c,
|
||||
0xe37f, 0xf35e, 0x02b1, 0x1290, 0x22f3, 0x32d2, 0x4235, 0x5214, 0x6277, 0x7256, 0xb5ea, 0xa5cb, 0x95a8, 0x8589, 0xf56e,
|
||||
0xe54f, 0xd52c, 0xc50d, 0x34e2, 0x24c3, 0x14a0, 0x0481, 0x7466, 0x6447, 0x5424, 0x4405, 0xa7db, 0xb7fa, 0x8799, 0x97b8,
|
||||
0xe75f, 0xf77e, 0xc71d, 0xd73c, 0x26d3, 0x36f2, 0x0691, 0x16b0, 0x6657, 0x7676, 0x4615, 0x5634, 0xd94c, 0xc96d, 0xf90e,
|
||||
0xe92f, 0x99c8, 0x89e9, 0xb98a, 0xa9ab, 0x5844, 0x4865, 0x7806, 0x6827, 0x18c0, 0x08e1, 0x3882, 0x28a3, 0xcb7d, 0xdb5c,
|
||||
0xeb3f, 0xfb1e, 0x8bf9, 0x9bd8, 0xabbb, 0xbb9a, 0x4a75, 0x5a54, 0x6a37, 0x7a16, 0x0af1, 0x1ad0, 0x2ab3, 0x3a92, 0xfd2e,
|
||||
0xed0f, 0xdd6c, 0xcd4d, 0xbdaa, 0xad8b, 0x9de8, 0x8dc9, 0x7c26, 0x6c07, 0x5c64, 0x4c45, 0x3ca2, 0x2c83, 0x1ce0, 0x0cc1,
|
||||
0xef1f, 0xff3e, 0xcf5d, 0xdf7c, 0xaf9b, 0xbfba, 0x8fd9, 0x9ff8, 0x6e17, 0x7e36, 0x4e55, 0x5e74, 0x2e93, 0x3eb2, 0x0ed1,
|
||||
0x1ef0};
|
||||
|
||||
/**
|
||||
* @note This implementation(with a few modifications) and corresponding table was generated using
|
||||
* pycrc v0.9.2 (MIT) using the XMODEM model. https://pycrc.org/. The code generated by pycrc
|
||||
* is not considered a substantial portion of the software, therefore the licence does not
|
||||
* cover the generated code, and the author of pycrc will not claim any copyright on the
|
||||
* generated code (https://pypi.org/project/pycrc/0.9.2/).
|
||||
*/
|
||||
uint16_t mmcrc_16_xmodem(uint16_t crc, const void *data, size_t data_len)
|
||||
{
|
||||
const uint8_t *d = (const uint8_t *)data;
|
||||
|
||||
while (data_len--) {
|
||||
crc = (crc16_xmodem_lookup_table[((crc >> 8) ^ *d++)] ^ (crc << 8));
|
||||
}
|
||||
return crc;
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,40 @@
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMCRC Morse Micro Cyclic Redundancy Check (mmcrc) API
|
||||
*
|
||||
* This API provides support for CRC algorithms used by Morse Micro code.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @brief Compute the CRC-16 for the data buffer using the XMODEM model.
|
||||
*
|
||||
* @param crc Seed for CRC calc, zero in most cases this is zero (0). If chaining calls
|
||||
* then this is the output from the previous invocation.
|
||||
* @param data Pointer to the start of the data to calculate the crc over.
|
||||
* @param data_len Length of the data array in bytes.
|
||||
*
|
||||
* @return Returns the CRC value.
|
||||
*/
|
||||
uint16_t mmcrc_16_xmodem(uint16_t crc, const void *data, size_t data_len);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,100 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "mmhal.h"
|
||||
#include "mmosal.h"
|
||||
#include "mmutils.h"
|
||||
#include "mmwlan.h"
|
||||
|
||||
#include "driver/gpio.h"
|
||||
#include "esp_random.h"
|
||||
#include "esp_system.h"
|
||||
#include "sdkconfig.h"
|
||||
|
||||
void mmhal_init(void)
|
||||
{
|
||||
/* We initialise the MM_RESET_N Pin here so that we can hold the MM6108 in reset regardless of
|
||||
* whether the mmhal_wlan_init/deinit function have been called. This allows us to ensure the
|
||||
* chip is in its lowest power state. You may want to revise this depending on your particular
|
||||
* hardware configuration. */
|
||||
gpio_config_t io_conf = {};
|
||||
io_conf.intr_type = GPIO_INTR_DISABLE;
|
||||
io_conf.mode = GPIO_MODE_OUTPUT;
|
||||
io_conf.pin_bit_mask = (1 << CONFIG_MM_RESET_N);
|
||||
io_conf.pull_down_en = 0;
|
||||
io_conf.pull_up_en = 0;
|
||||
gpio_config(&io_conf);
|
||||
|
||||
gpio_set_level(CONFIG_MM_RESET_N, 0);
|
||||
|
||||
/* Initialise the gpio ISR handler service. This allows per-pin GPIO interrupt handlers and is
|
||||
* what is used to register all the wlan related interrupt. */
|
||||
gpio_install_isr_service(0);
|
||||
}
|
||||
|
||||
void mmhal_log_write(const uint8_t *data, size_t length)
|
||||
{
|
||||
while (length--) {
|
||||
putc(*data++, stdout);
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_log_flush(void) {}
|
||||
|
||||
void mmhal_read_mac_addr(uint8_t *mac_addr)
|
||||
{
|
||||
/* We do not override the MAC address here. Therefore the driver will attempt to read it from
|
||||
* the chip and failing that will assign a randomly generated address. */
|
||||
(void)(mac_addr);
|
||||
}
|
||||
|
||||
uint32_t mmhal_random_u32(uint32_t min, uint32_t max)
|
||||
{
|
||||
/* Note: the below implementation does not guarantee a uniform distribution. */
|
||||
|
||||
uint32_t random_value = esp_random();
|
||||
|
||||
if (min == 0 && max == UINT32_MAX) {
|
||||
return random_value;
|
||||
} else {
|
||||
/* Calculate the range and shift required to fit within [min, max] */
|
||||
return (random_value % (max - min + 1)) + min;
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_reset(void)
|
||||
{
|
||||
esp_restart();
|
||||
while (1) {
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_set_deep_sleep_veto(uint8_t veto_id)
|
||||
{
|
||||
MM_UNUSED(veto_id);
|
||||
}
|
||||
|
||||
void mmhal_clear_deep_sleep_veto(uint8_t veto_id)
|
||||
{
|
||||
MM_UNUSED(veto_id);
|
||||
}
|
||||
|
||||
void mmhal_set_led(uint8_t led, uint8_t level)
|
||||
{
|
||||
MM_UNUSED(led);
|
||||
MM_UNUSED(level);
|
||||
}
|
||||
|
||||
bool mmhal_get_hardware_version(char *version_buffer, size_t version_buffer_length)
|
||||
{
|
||||
/* Note: You need to identify the correct hardware and or version
|
||||
* here using whatever means available (GPIO's, version number stored in EEPROM, etc)
|
||||
* and return the correct string here. */
|
||||
return !mmosal_safer_strcpy(version_buffer, "MM-ESP32S3 V1.0", version_buffer_length);
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,72 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "mmhal_wlan.h"
|
||||
#include "mmosal.h"
|
||||
|
||||
/*
|
||||
* ---------------------------------------------------------------------------------------------
|
||||
* BCF Retrieval
|
||||
* ---------------------------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
/*
|
||||
* The following implementation reads the BCF File from the config store.
|
||||
*/
|
||||
|
||||
void mmhal_wlan_read_bcf_file(uint32_t offset, uint32_t requested_len, struct mmhal_robuf *robuf)
|
||||
{
|
||||
/** Points to the start of the BCF binary image. Defined as part of the Makefile */
|
||||
extern uint8_t bcf_binary_start;
|
||||
/** Points to the end of the BCF binary image. Defined as part of the Makefile */
|
||||
extern uint8_t bcf_binary_end;
|
||||
|
||||
size_t bcf_len = &bcf_binary_end - &bcf_binary_start;
|
||||
|
||||
/* Initialise robuf */
|
||||
robuf->buf = NULL;
|
||||
robuf->len = 0;
|
||||
robuf->free_arg = NULL;
|
||||
robuf->free_cb = NULL;
|
||||
|
||||
/* Sanity check */
|
||||
if (bcf_len < offset) {
|
||||
printf("Detected an attempt to start reading off the end of the bcf file.\n");
|
||||
return;
|
||||
}
|
||||
|
||||
robuf->buf = (uint8_t *)&bcf_binary_start + offset;
|
||||
robuf->len = bcf_len - offset;
|
||||
robuf->len = (robuf->len < requested_len) ? robuf->len : requested_len;
|
||||
}
|
||||
|
||||
/*
|
||||
* ---------------------------------------------------------------------------------------------
|
||||
* Firmware Retrieval
|
||||
* ---------------------------------------------------------------------------------------------
|
||||
*/
|
||||
/** Points to the start of the firmware binary image. Defined as part of the Makefile */
|
||||
extern uint8_t firmware_binary_start;
|
||||
/** Points to the end of the firmware binary image. Defined as part of the Makefile */
|
||||
extern uint8_t firmware_binary_end;
|
||||
|
||||
void mmhal_wlan_read_fw_file(uint32_t offset, uint32_t requested_len, struct mmhal_robuf *robuf)
|
||||
{
|
||||
uint32_t firmware_len = &firmware_binary_end - &firmware_binary_start;
|
||||
if (offset > firmware_len) {
|
||||
printf("Detected an attempt to start read off the end of the firmware file.\n");
|
||||
robuf->buf = NULL;
|
||||
return;
|
||||
}
|
||||
|
||||
robuf->buf = (&firmware_binary_start + offset);
|
||||
firmware_len -= offset;
|
||||
|
||||
robuf->len = (firmware_len < requested_len) ? firmware_len : requested_len;
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,726 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "mmipal.h"
|
||||
#include "mmnetif.h"
|
||||
#include "mmosal.h"
|
||||
#include "mmutils.h"
|
||||
#include "mmwlan.h"
|
||||
|
||||
#include "lwip/api.h"
|
||||
#include "lwip/autoip.h"
|
||||
#include "lwip/def.h"
|
||||
#include "lwip/dhcp.h"
|
||||
#include "lwip/dhcp6.h"
|
||||
#include "lwip/dns.h"
|
||||
#include "lwip/etharp.h"
|
||||
#include "lwip/ethip6.h"
|
||||
#include "lwip/igmp.h"
|
||||
#include "lwip/inet.h"
|
||||
#include "lwip/ip4_frag.h"
|
||||
#include "lwip/ip6_frag.h"
|
||||
#include "lwip/ip_addr.h"
|
||||
#include "lwip/mem.h"
|
||||
#include "lwip/sockets.h"
|
||||
#include "lwip/stats.h"
|
||||
#include "lwip/tcp.h"
|
||||
#include "lwip/tcpip.h"
|
||||
#include "lwip/udp.h"
|
||||
|
||||
static struct mmipal_data {
|
||||
struct netif lwip_mmnetif;
|
||||
/** This stores the IPv4 link state for the IP stack. I.e., do we have an IP address or not. */
|
||||
enum mmipal_link_state ip_link_state;
|
||||
/** Flag requesting ARP response offload feature */
|
||||
bool offload_arp_response;
|
||||
/** ARP refresh offload interval in seconds */
|
||||
uint32_t offload_arp_refresh_s;
|
||||
bool dhcp_offload_init_complete;
|
||||
/** The link status callback function that has been registered. */
|
||||
mmipal_link_status_cb_fn_t link_status_callback;
|
||||
/** The extended link status callback function that has been registered. */
|
||||
mmipal_ext_link_status_cb_fn_t ext_link_status_callback;
|
||||
/** Argument for the extended link status callback function that has been registered. */
|
||||
void *ext_link_status_callback_arg;
|
||||
#if LWIP_IPV4
|
||||
enum mmipal_addr_mode ip4_mode;
|
||||
#endif
|
||||
#if LWIP_IPV6
|
||||
enum mmipal_ip6_addr_mode ip6_mode;
|
||||
#endif
|
||||
} mmipal_data = {};
|
||||
|
||||
/** Getter function to retrieve the global mmipal data structure.*/
|
||||
static inline struct mmipal_data *mmipal_get_data(void)
|
||||
{
|
||||
return &mmipal_data;
|
||||
}
|
||||
|
||||
static void netif_status_callback(struct netif *netif);
|
||||
|
||||
#if LWIP_IPV4
|
||||
|
||||
/**
|
||||
* DHCP Lease update callback, invoked when we get a new DHCP lease.
|
||||
*
|
||||
* @param lease_info The new DHCP lease.
|
||||
*/
|
||||
static void mmipal_dhcp_lease_updated(const struct mmwlan_dhcp_lease_info *lease_info, void *arg)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
|
||||
ip4_addr_t ip_addr, netmask, gateway;
|
||||
ip_addr_t dns_addr = ip_addr_any;
|
||||
|
||||
MM_UNUSED(arg);
|
||||
|
||||
data->dhcp_offload_init_complete = true;
|
||||
|
||||
ip4_addr_set_u32(&ip_addr, lease_info->ip4_addr);
|
||||
ip4_addr_set_u32(&netmask, lease_info->mask4_addr);
|
||||
ip4_addr_set_u32(&gateway, lease_info->gw4_addr);
|
||||
ip4_addr_set_u32(ip_2_ip4(&dns_addr), lease_info->dns4_addr);
|
||||
|
||||
LOCK_TCPIP_CORE();
|
||||
netif_set_addr(&data->lwip_mmnetif, &ip_addr, &netmask, &gateway);
|
||||
dns_setserver(0, &dns_addr);
|
||||
UNLOCK_TCPIP_CORE();
|
||||
|
||||
netif_status_callback(&data->lwip_mmnetif);
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_get_ip_config(struct mmipal_ip_config *config)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
char *result;
|
||||
|
||||
config->mode = data->ip4_mode;
|
||||
|
||||
result = ipaddr_ntoa_r(&data->lwip_mmnetif.ip_addr, config->ip_addr, sizeof(config->ip_addr));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
result = ipaddr_ntoa_r(&data->lwip_mmnetif.netmask, config->netmask, sizeof(config->netmask));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
result = ipaddr_ntoa_r(&data->lwip_mmnetif.gw, config->gateway_addr, sizeof(config->gateway_addr));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_set_ip_config(const struct mmipal_ip_config *config)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
int result;
|
||||
ip_addr_t ip_addr = ip_addr_any;
|
||||
ip_addr_t netmask = ip_addr_any;
|
||||
ip_addr_t gateway = ip_addr_any;
|
||||
struct netif *netif = &data->lwip_mmnetif;
|
||||
|
||||
if (config->mode != MMIPAL_DHCP_OFFLOAD && data->ip4_mode == MMIPAL_DHCP_OFFLOAD) {
|
||||
printf("Once enabled DHCP offload mode cannot be disabled\n");
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
switch (config->mode) {
|
||||
case MMIPAL_DISABLED:
|
||||
printf("%s mode not supported\n", "DISABLED");
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
|
||||
case MMIPAL_AUTOIP:
|
||||
printf("%s mode not supported\n", "AutoIP");
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
|
||||
case MMIPAL_DHCP_OFFLOAD:
|
||||
/* Currently we only support enabling DHCP offload when initialising */
|
||||
printf("%s mode not supported\n", "DHCP_OFFLOAD");
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
|
||||
case MMIPAL_STATIC:
|
||||
result = ipaddr_aton(config->ip_addr, &ip_addr);
|
||||
if (!result) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
result = ipaddr_aton(config->netmask, &netmask);
|
||||
if (!result) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
result = ipaddr_aton(config->gateway_addr, &gateway);
|
||||
if (!result) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
break;
|
||||
|
||||
case MMIPAL_DHCP:
|
||||
break;
|
||||
}
|
||||
|
||||
LOCK_TCPIP_CORE();
|
||||
|
||||
if (config->mode != MMIPAL_DHCP && data->ip4_mode == MMIPAL_DHCP) {
|
||||
/* Stop DHCP if it was started earlier before setting static IP */
|
||||
dhcp_stop(netif);
|
||||
}
|
||||
|
||||
data->ip4_mode = config->mode;
|
||||
|
||||
netif_set_addr(netif, ip_2_ip4(&ip_addr), ip_2_ip4(&netmask), ip_2_ip4(&gateway));
|
||||
if (data->ip4_mode == MMIPAL_DHCP) {
|
||||
result = dhcp_start(netif);
|
||||
LWIP_ASSERT("DHCP start error", result == ERR_OK);
|
||||
}
|
||||
|
||||
UNLOCK_TCPIP_CORE();
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_get_ip_broadcast_addr(mmipal_ip_addr_t broadcast_addr)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
char *result;
|
||||
|
||||
uint32_t ip_addr = ip_addr_get_ip4_u32(&data->lwip_mmnetif.ip_addr);
|
||||
uint32_t netmask = ip_addr_get_ip4_u32(&data->lwip_mmnetif.netmask);
|
||||
uint32_t broadcast_u32 = (ip_addr & netmask) | (0xffffffff & ~netmask);
|
||||
ip_addr_t broadcast_ip_addr;
|
||||
ip_addr_t *_broadcast_ip_addr = &broadcast_ip_addr;
|
||||
ip_addr_set_ip4_u32(_broadcast_ip_addr, broadcast_u32);
|
||||
|
||||
result = ipaddr_ntoa_r(&broadcast_ip_addr, broadcast_addr, MMIPAL_IPADDR_STR_MAXLEN);
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
#else
|
||||
enum mmipal_status mmipal_get_ip_config(struct mmipal_ip_config *config)
|
||||
{
|
||||
MM_UNUSED(config);
|
||||
LWIP_ASSERT("IPv4 not enabled", false);
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_set_ip_config(const struct mmipal_ip_config *config)
|
||||
{
|
||||
MM_UNUSED(config);
|
||||
LWIP_ASSERT("IPv4 not enabled", false);
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_get_ip_broadcast_addr(mmipal_ip_addr_t broadcast_addr)
|
||||
{
|
||||
MM_UNUSED(broadcast_addr);
|
||||
LWIP_ASSERT("IPv4 not enabled", false);
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
#if LWIP_IPV6
|
||||
|
||||
enum mmipal_status mmipal_get_ip6_config(struct mmipal_ip6_config *config)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
unsigned ii;
|
||||
struct netif *netif = &data->lwip_mmnetif;
|
||||
|
||||
if (config == NULL) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
config->ip6_mode = data->ip6_mode;
|
||||
for (ii = 0; ii < LWIP_IPV6_NUM_ADDRESSES; ii++) {
|
||||
char *result;
|
||||
const ip_addr_t *addr = &ip6_addr_any;
|
||||
|
||||
if (ip6_addr_isvalid(netif_ip6_addr_state(netif, ii))) {
|
||||
addr = &data->lwip_mmnetif.ip6_addr[ii];
|
||||
}
|
||||
|
||||
result = ipaddr_ntoa_r(addr, config->ip6_addr[ii], sizeof(config->ip6_addr[ii]));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
}
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_set_ip6_config(const struct mmipal_ip6_config *config)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
struct netif *netif = &data->lwip_mmnetif;
|
||||
err_t result;
|
||||
unsigned ii;
|
||||
ip_addr_t ip6_addr[LWIP_IPV6_NUM_ADDRESSES];
|
||||
|
||||
for (ii = 0; ii < LWIP_IPV6_NUM_ADDRESSES; ii++) {
|
||||
int result = ipaddr_aton(config->ip6_addr[ii], &ip6_addr[ii]);
|
||||
if (!result) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
}
|
||||
|
||||
LOCK_TCPIP_CORE();
|
||||
|
||||
if (config->ip6_mode == MMIPAL_IP6_STATIC) {
|
||||
if (data->ip6_mode != MMIPAL_IP6_STATIC) {
|
||||
#if LWIP_IPV6_DHCP6
|
||||
dhcp6_disable(netif);
|
||||
#endif
|
||||
netif_set_ip6_autoconfig_enabled(netif, 0);
|
||||
data->ip6_mode = MMIPAL_IP6_STATIC;
|
||||
}
|
||||
|
||||
if (!ip6_addr_islinklocal(ip_2_ip6(&(ip6_addr[0])))) {
|
||||
printf("First address must be linklocal address (address start with fe80)\n");
|
||||
}
|
||||
|
||||
for (ii = 0; ii < LWIP_IPV6_NUM_ADDRESSES; ii++) {
|
||||
if (ip_addr_isany_val(ip6_addr[ii])) {
|
||||
netif_ip6_addr_set(netif, ii, IP6_ADDR_ANY6);
|
||||
netif_ip6_addr_set_state(netif, ii, IP6_ADDR_INVALID);
|
||||
} else {
|
||||
netif_ip6_addr_set(netif, ii, ip_2_ip6(&(ip6_addr[ii])));
|
||||
netif_ip6_addr_set_state(netif, ii, IP6_ADDR_TENTATIVE);
|
||||
netif_ip6_addr_set_valid_life(netif, ii, IP6_ADDR_LIFE_STATIC);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
if (data->ip6_mode == MMIPAL_IP6_STATIC) {
|
||||
for (ii = 0; ii < LWIP_IPV6_NUM_ADDRESSES; ii++) {
|
||||
netif_ip6_addr_set(netif, ii, IP6_ADDR_ANY6);
|
||||
netif_ip6_addr_set_state(netif, ii, IP6_ADDR_INVALID);
|
||||
}
|
||||
}
|
||||
netif_set_ip6_autoconfig_enabled(netif, 1);
|
||||
netif_create_ip6_linklocal_address(netif, 1);
|
||||
data->ip6_mode = MMIPAL_IP6_AUTOCONFIG;
|
||||
}
|
||||
|
||||
if (config->ip6_mode == MMIPAL_IP6_DHCP6_STATELESS)
|
||||
#if LWIP_IPV6_DHCP6
|
||||
{
|
||||
result = dhcp6_enable_stateless(netif);
|
||||
LWIP_ASSERT("Stateless DHCP6 start error", result == ERR_OK);
|
||||
data->ip6_mode = MMIPAL_IP6_DHCP6_STATELESS;
|
||||
} else {
|
||||
dhcp6_disable(netif);
|
||||
}
|
||||
#else
|
||||
{
|
||||
printf("LWIP_IPV6_DHCP6 is not enabled\n");
|
||||
}
|
||||
#endif
|
||||
|
||||
UNLOCK_TCPIP_CORE();
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
#else
|
||||
enum mmipal_status mmipal_get_ip6_config(struct mmipal_ip6_config *config)
|
||||
{
|
||||
MM_UNUSED(config);
|
||||
LWIP_ASSERT("IPv6 not enabled", false);
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_set_ip6_config(const struct mmipal_ip6_config *config)
|
||||
{
|
||||
MM_UNUSED(config);
|
||||
LWIP_ASSERT("IPv6 not enabled", false);
|
||||
return MMIPAL_NOT_SUPPORTED;
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
static bool mmipal_link_status_check(struct netif *netif)
|
||||
{
|
||||
bool ip4_addr_check = true;
|
||||
|
||||
#if LWIP_IPV4
|
||||
ip4_addr_check = !ip_addr_isany(&(netif->ip_addr));
|
||||
#endif
|
||||
|
||||
return ip4_addr_check && netif_is_link_up(netif);
|
||||
}
|
||||
|
||||
/** Handler for @c netif status callbacks from LWIP. */
|
||||
static void netif_status_callback(struct netif *netif)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
enum mmipal_link_state new_link_state = MMIPAL_LINK_DOWN;
|
||||
|
||||
#if LWIP_IPV4
|
||||
if (data->ip4_mode == MMIPAL_DHCP_OFFLOAD) {
|
||||
/* Initialize DHCP offload on link up */
|
||||
if (mmwlan_enable_dhcp_offload(mmipal_dhcp_lease_updated, NULL) != MMWLAN_SUCCESS) {
|
||||
printf("Failed to enable DHCP offload!\n");
|
||||
}
|
||||
|
||||
if (!data->dhcp_offload_init_complete) {
|
||||
/* This just prevents a spurious 'Link Up' message on very first call */
|
||||
return;
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
if (mmipal_link_status_check(netif)) {
|
||||
new_link_state = MMIPAL_LINK_UP;
|
||||
}
|
||||
|
||||
if (data->ip_link_state != new_link_state) {
|
||||
data->ip_link_state = new_link_state;
|
||||
|
||||
if (data->link_status_callback || data->ext_link_status_callback) {
|
||||
struct mmipal_link_status link_status;
|
||||
memset(&link_status, 0, sizeof(link_status));
|
||||
link_status.link_state = data->ip_link_state;
|
||||
|
||||
#if LWIP_IPV4
|
||||
char *result = ipaddr_ntoa_r(&netif->ip_addr, link_status.ip_addr, sizeof(link_status.ip_addr));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
result = ipaddr_ntoa_r(&netif->netmask, link_status.netmask, sizeof(link_status.netmask));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
result = ipaddr_ntoa_r(&netif->gw, link_status.gateway, sizeof(link_status.gateway));
|
||||
LWIP_ASSERT("IP buf too short", result != NULL);
|
||||
|
||||
if (data->ip_link_state == MMIPAL_LINK_UP) {
|
||||
/* Check if ARP response offload feature is enabled */
|
||||
if (data->offload_arp_response) {
|
||||
mmwlan_enable_arp_response_offload(ip4_addr_get_u32(netif_ip4_addr(netif)));
|
||||
}
|
||||
|
||||
/* Check if ARP refresh offload feature is enabled */
|
||||
if (data->offload_arp_refresh_s > 0) {
|
||||
mmwlan_enable_arp_refresh_offload(data->offload_arp_refresh_s, ip4_addr_get_u32(netif_ip4_gw(netif)), true);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
if (data->link_status_callback) {
|
||||
data->link_status_callback(&link_status);
|
||||
}
|
||||
if (data->ext_link_status_callback) {
|
||||
data->ext_link_status_callback(&link_status, data->ext_link_status_callback_arg);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
void mmipal_set_link_status_callback(mmipal_link_status_cb_fn_t fn)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
data->link_status_callback = fn;
|
||||
}
|
||||
|
||||
void mmipal_set_ext_link_status_callback(mmipal_ext_link_status_cb_fn_t fn, void *arg)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
data->ext_link_status_callback = fn;
|
||||
data->ext_link_status_callback_arg = arg;
|
||||
}
|
||||
|
||||
static volatile bool tcpip_init_done = false;
|
||||
|
||||
struct lwip_init_args {
|
||||
enum mmipal_addr_mode mode;
|
||||
enum mmipal_ip6_addr_mode ip6_mode;
|
||||
ip_addr_t ip_addr;
|
||||
ip_addr_t netmask;
|
||||
ip_addr_t gateway_addr;
|
||||
ip_addr_t ip6_addr;
|
||||
};
|
||||
|
||||
static void tcpip_init_done_handler(void *arg)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
struct netif *netif = &data->lwip_mmnetif;
|
||||
struct lwip_init_args *args = (struct lwip_init_args *)arg;
|
||||
|
||||
netif_add_noaddr(netif, NULL, mmnetif_init, tcpip_input);
|
||||
netif_set_default(netif);
|
||||
netif_set_up(netif);
|
||||
|
||||
#if LWIP_IPV4
|
||||
err_t result;
|
||||
data->ip4_mode = args->mode;
|
||||
if (args->mode == MMIPAL_DHCP) {
|
||||
result = dhcp_start(netif);
|
||||
LWIP_ASSERT("DHCP start error", result == ERR_OK);
|
||||
} else if (args->mode == MMIPAL_STATIC) {
|
||||
netif_set_addr(netif, ip_2_ip4(&(args->ip_addr)), ip_2_ip4(&(args->netmask)), ip_2_ip4(&(args->gateway_addr)));
|
||||
}
|
||||
#endif
|
||||
|
||||
netif_set_link_callback(netif, netif_status_callback);
|
||||
netif_set_status_callback(netif, netif_status_callback);
|
||||
|
||||
#if LWIP_IPV6
|
||||
err_t result6;
|
||||
data->ip6_mode = args->ip6_mode;
|
||||
if (args->ip6_mode == MMIPAL_IP6_STATIC) {
|
||||
netif_ip6_addr_set(netif, 0, ip_2_ip6(&(args->ip6_addr)));
|
||||
netif_ip6_addr_set_state(netif, 0, IP6_ADDR_TENTATIVE);
|
||||
} else if (data->ip6_mode == MMIPAL_IP6_AUTOCONFIG) {
|
||||
netif_set_ip6_autoconfig_enabled(netif, 1);
|
||||
netif_create_ip6_linklocal_address(netif, 1);
|
||||
} else if (data->ip6_mode == MMIPAL_IP6_DHCP6_STATELESS)
|
||||
#if LWIP_IPV6_DHCP6
|
||||
{
|
||||
result6 = dhcp6_enable_stateless(netif);
|
||||
LWIP_ASSERT("Stateless DHCP6 start error", result6 == ERR_OK);
|
||||
}
|
||||
#else
|
||||
{
|
||||
printf("LWIP_IPV6_DHCP6 is not enabled\n");
|
||||
}
|
||||
#endif
|
||||
#endif
|
||||
|
||||
mmosal_free(args);
|
||||
|
||||
tcpip_init_done = true;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_init(const struct mmipal_init_args *args)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
enum mmipal_status status = MMIPAL_INVALID_ARGUMENT;
|
||||
int result;
|
||||
|
||||
struct lwip_init_args *lwip_args = (struct lwip_init_args *)mmosal_malloc(sizeof(*lwip_args));
|
||||
if (lwip_args == NULL) {
|
||||
printf("malloc failure\n");
|
||||
return MMIPAL_NO_MEM;
|
||||
}
|
||||
|
||||
memset(lwip_args, 0, sizeof(*lwip_args));
|
||||
lwip_args->mode = args->mode;
|
||||
lwip_args->ip6_mode = args->ip6_mode;
|
||||
|
||||
data->link_status_callback = NULL;
|
||||
|
||||
data->offload_arp_response = args->offload_arp_response;
|
||||
data->offload_arp_refresh_s = args->offload_arp_refresh_s;
|
||||
|
||||
/* Validate arguments */
|
||||
#if LWIP_IPV4
|
||||
switch (args->mode) {
|
||||
case MMIPAL_DISABLED:
|
||||
printf("%s mode not supported\n", "DISABLED");
|
||||
goto exit;
|
||||
|
||||
case MMIPAL_DHCP_OFFLOAD:
|
||||
case MMIPAL_STATIC:
|
||||
result = ipaddr_aton(args->ip_addr, &lwip_args->ip_addr);
|
||||
if (!result) {
|
||||
goto exit;
|
||||
}
|
||||
result = ipaddr_aton(args->netmask, &lwip_args->netmask);
|
||||
if (!result) {
|
||||
goto exit;
|
||||
}
|
||||
result = ipaddr_aton(args->gateway_addr, &lwip_args->gateway_addr);
|
||||
if (!result) {
|
||||
goto exit;
|
||||
}
|
||||
|
||||
if (ip_addr_isany_val(lwip_args->ip_addr)) {
|
||||
printf("IP address not specified\n");
|
||||
goto exit;
|
||||
}
|
||||
break;
|
||||
|
||||
case MMIPAL_DHCP:
|
||||
if (LWIP_DHCP == 0) {
|
||||
printf("DHCP not compiled in\n");
|
||||
goto exit;
|
||||
}
|
||||
break;
|
||||
|
||||
case MMIPAL_AUTOIP:
|
||||
printf("%s mode not supported\n", "AutoIP");
|
||||
break;
|
||||
}
|
||||
#endif
|
||||
|
||||
#if LWIP_IPV6
|
||||
switch (args->ip6_mode) {
|
||||
case MMIPAL_IP6_DISABLED:
|
||||
break;
|
||||
|
||||
case MMIPAL_IP6_STATIC:
|
||||
result = ipaddr_aton(args->ip6_addr, &lwip_args->ip6_addr);
|
||||
if (!result) {
|
||||
goto exit;
|
||||
}
|
||||
|
||||
if (ip_addr_isany_val(lwip_args->ip6_addr)) {
|
||||
printf("IP address not specified\n");
|
||||
goto exit;
|
||||
}
|
||||
break;
|
||||
|
||||
case MMIPAL_IP6_AUTOCONFIG:
|
||||
if (LWIP_IPV6_AUTOCONFIG == 0) {
|
||||
printf("AUTOCONFIG not compiled in\n");
|
||||
goto exit;
|
||||
}
|
||||
break;
|
||||
|
||||
case MMIPAL_IP6_DHCP6_STATELESS:
|
||||
if (LWIP_IPV6_DHCP6_STATELESS == 0) {
|
||||
printf("DHCP6_STATELESS not compiled in\n");
|
||||
goto exit;
|
||||
}
|
||||
break;
|
||||
}
|
||||
#endif
|
||||
|
||||
tcpip_init(tcpip_init_done_handler, lwip_args);
|
||||
|
||||
/* Block until initialisation is complete */
|
||||
while (!tcpip_init_done) {
|
||||
mmosal_task_sleep(10);
|
||||
}
|
||||
|
||||
return MMIPAL_SUCCESS;
|
||||
|
||||
exit:
|
||||
mmosal_free(lwip_args);
|
||||
return status;
|
||||
}
|
||||
|
||||
void mmipal_get_link_packet_counts(uint32_t *tx_packets, uint32_t *rx_packets)
|
||||
{
|
||||
#if LWIP_STATS
|
||||
*tx_packets = lwip_stats.link.xmit;
|
||||
*rx_packets = lwip_stats.link.recv;
|
||||
#else
|
||||
*tx_packets = 0;
|
||||
*rx_packets = 0;
|
||||
#endif
|
||||
}
|
||||
|
||||
void mmipal_set_tx_qos_tid(uint8_t tid)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
bool ok = tcpip_init_done;
|
||||
MMOSAL_ASSERT(ok);
|
||||
mmnetif_set_tx_qos_tid(&data->lwip_mmnetif, tid);
|
||||
}
|
||||
|
||||
enum mmipal_link_state mmipal_get_link_state(void)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
return data->ip_link_state;
|
||||
}
|
||||
|
||||
static enum mmipal_status mmipal_get_local_addr_(ip_addr_t *local_addr, const ip_addr_t *dest_addr)
|
||||
{
|
||||
struct mmipal_data *data = mmipal_get_data();
|
||||
struct netif *netif = &data->lwip_mmnetif;
|
||||
#if LWIP_IPV6
|
||||
if (IP_IS_V6(dest_addr)) {
|
||||
const ip_addr_t *src_addr = ip6_select_source_address(netif, ip_2_ip6(dest_addr));
|
||||
if (src_addr == NULL) {
|
||||
return MMIPAL_NO_LINK;
|
||||
}
|
||||
ip_addr_copy(*local_addr, *src_addr);
|
||||
return MMIPAL_SUCCESS;
|
||||
} else {
|
||||
MM_UNUSED(dest_addr);
|
||||
}
|
||||
#endif
|
||||
|
||||
#if LWIP_IPV4
|
||||
if (IP_IS_V4(dest_addr)) {
|
||||
ip_addr_copy(*local_addr, netif->ip_addr);
|
||||
return MMIPAL_SUCCESS;
|
||||
} else {
|
||||
MM_UNUSED(dest_addr);
|
||||
}
|
||||
#endif
|
||||
|
||||
#if !LWIP_IPV4 && !LWIP_IPV6
|
||||
MM_UNUSED(local_addr);
|
||||
MM_UNUSED(dest_addr);
|
||||
#endif
|
||||
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_get_local_addr(mmipal_ip_addr_t local_addr, const mmipal_ip_addr_t dest_addr)
|
||||
{
|
||||
ip_addr_t lwip_dest_addr;
|
||||
ip_addr_t lwip_local_addr;
|
||||
int ok;
|
||||
enum mmipal_status status;
|
||||
|
||||
if (dest_addr == NULL) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
ok = ipaddr_aton(dest_addr, &lwip_dest_addr);
|
||||
if (!ok) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
status = mmipal_get_local_addr_(&lwip_local_addr, &lwip_dest_addr);
|
||||
if (status != 0) {
|
||||
return status;
|
||||
}
|
||||
|
||||
if (ipaddr_ntoa_r(&lwip_local_addr, local_addr, MMIPAL_IPADDR_STR_MAXLEN) == NULL) {
|
||||
return MMIPAL_NO_MEM;
|
||||
} else {
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_set_dns_server(uint8_t index, const mmipal_ip_addr_t addr)
|
||||
{
|
||||
ip_addr_t dns_addr;
|
||||
int ok;
|
||||
|
||||
if (index >= DNS_MAX_SERVERS) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
ok = ipaddr_aton(addr, &dns_addr);
|
||||
if (!ok) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
dns_setserver(index, &dns_addr);
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
|
||||
enum mmipal_status mmipal_get_dns_server(uint8_t index, mmipal_ip_addr_t addr)
|
||||
{
|
||||
const ip_addr_t *dns_addr;
|
||||
|
||||
if (index >= DNS_MAX_SERVERS) {
|
||||
return MMIPAL_INVALID_ARGUMENT;
|
||||
}
|
||||
|
||||
dns_addr = dns_getserver(index);
|
||||
|
||||
#if LWIP_IPV4
|
||||
/* dns_getserver() returns ip_addr_any if no address configured. */
|
||||
if (!memcmp(dns_addr, &ip_addr_any, sizeof(*dns_addr))) {
|
||||
addr[0] = '\0';
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
#endif
|
||||
|
||||
if (ipaddr_ntoa_r(dns_addr, addr, MMIPAL_IPADDR_STR_MAXLEN) == NULL) {
|
||||
return MMIPAL_NO_MEM;
|
||||
} else {
|
||||
return MMIPAL_SUCCESS;
|
||||
}
|
||||
}
|
||||
|
||||
#endif
|
||||
@@ -0,0 +1,218 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "mmnetif.h"
|
||||
#include "mmosal.h"
|
||||
#include "mmwlan.h"
|
||||
|
||||
#include "lwip/etharp.h"
|
||||
#include "lwip/ethip6.h"
|
||||
#include "lwip/tcpip.h"
|
||||
#if LWIP_SNMP
|
||||
#include "lwip/snmp.h"
|
||||
#endif
|
||||
|
||||
struct netif_state {
|
||||
volatile uint8_t tx_qos_tid;
|
||||
};
|
||||
|
||||
static struct netif_state *get_netif_state(struct netif *netif)
|
||||
{
|
||||
MMOSAL_ASSERT(netif->state != NULL);
|
||||
return (struct netif_state *)netif->state;
|
||||
}
|
||||
|
||||
/** pbuf wrapper around an mmpkt. */
|
||||
struct mmpkt_pbuf_wrapper {
|
||||
struct pbuf_custom p;
|
||||
struct mmpkt *pkt;
|
||||
struct mmpktview *pktview;
|
||||
};
|
||||
|
||||
LWIP_MEMPOOL_DECLARE(RX_POOL, MMPKTMEM_RX_POOL_N_BLOCKS, sizeof(struct mmpkt_pbuf_wrapper), "mmpkt_rx");
|
||||
|
||||
static void mmpkt_pbuf_wrapper_free(struct pbuf *p)
|
||||
{
|
||||
struct mmpkt_pbuf_wrapper *pbuf = (struct mmpkt_pbuf_wrapper *)p;
|
||||
if (p == NULL) {
|
||||
return;
|
||||
}
|
||||
mmpkt_close(&pbuf->pktview);
|
||||
mmpkt_release(pbuf->pkt);
|
||||
LWIP_MEMPOOL_FREE(RX_POOL, pbuf);
|
||||
}
|
||||
|
||||
static void mmnetif_rx(struct mmpkt *rxpkt, void *arg)
|
||||
{
|
||||
struct netif *netif = (struct netif *)arg;
|
||||
LWIP_ASSERT("arg NULL", netif != NULL);
|
||||
|
||||
LWIP_DEBUGF(NETIF_DEBUG, ("mmnetif: packet received\n"));
|
||||
|
||||
struct mmpkt_pbuf_wrapper *pbuf = (struct mmpkt_pbuf_wrapper *)LWIP_MEMPOOL_ALLOC(RX_POOL);
|
||||
if (pbuf != NULL) {
|
||||
struct pbuf *p;
|
||||
|
||||
pbuf->p.custom_free_function = mmpkt_pbuf_wrapper_free;
|
||||
pbuf->pkt = rxpkt;
|
||||
pbuf->pktview = mmpkt_open(pbuf->pkt);
|
||||
|
||||
p = pbuf_alloced_custom(PBUF_RAW, mmpkt_get_data_length(pbuf->pktview), PBUF_REF, &pbuf->p,
|
||||
mmpkt_get_data_start(pbuf->pktview), mmpkt_get_data_length(pbuf->pktview));
|
||||
int ret = tcpip_input(p, netif);
|
||||
if (ret == ERR_OK) {
|
||||
LINK_STATS_INC(link.recv);
|
||||
} else {
|
||||
LWIP_DEBUGF(NETIF_DEBUG, ("mmnetif: input error\n"));
|
||||
pbuf_free(p);
|
||||
LINK_STATS_INC(link.memerr);
|
||||
LINK_STATS_INC(link.drop);
|
||||
}
|
||||
} else {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_SERIOUS, ("mmnetif: alloc error\n"));
|
||||
LINK_STATS_INC(link.memerr);
|
||||
mmpkt_release(rxpkt);
|
||||
}
|
||||
}
|
||||
|
||||
static void mmnetif_link_state(enum mmwlan_link_state link_state, void *arg)
|
||||
{
|
||||
struct netif *netif = (struct netif *)arg;
|
||||
LWIP_ASSERT("arg NULL", netif != NULL);
|
||||
|
||||
LOCK_TCPIP_CORE();
|
||||
if (link_state == MMWLAN_LINK_DOWN) {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_ALL, ("mmnetif: link down\n"));
|
||||
/* Note: we cast netif_set_link_down to tcpip_callback_fn since the tcpip_callback_fn
|
||||
* has a "void *" parameter and netif_set_link_down has "struct netif *". */
|
||||
err_t err = tcpip_callback_with_block((tcpip_callback_fn)netif_set_link_down, netif, 0);
|
||||
LWIP_ASSERT("sched callback failed", err == ERR_OK);
|
||||
} else {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_ALL, ("mmnetif: link up\n"));
|
||||
/* Note: we cast netif_set_link_down to tcpip_callback_fn since the tcpip_callback_fn
|
||||
* has a "void *" parameter and netif_set_link_down has "struct netif *". */
|
||||
err_t err = tcpip_callback_with_block((tcpip_callback_fn)netif_set_link_up, netif, 0);
|
||||
LWIP_ASSERT("sched callback failed", err == ERR_OK);
|
||||
}
|
||||
UNLOCK_TCPIP_CORE();
|
||||
}
|
||||
|
||||
static err_t mmnetif_tx(struct netif *netif, struct pbuf *p)
|
||||
{
|
||||
struct mmpkt *pkt;
|
||||
struct mmpktview *pktview;
|
||||
enum mmwlan_status status;
|
||||
struct pbuf *walk;
|
||||
struct mmwlan_tx_metadata metadata = {
|
||||
.tid = get_netif_state(netif)->tx_qos_tid,
|
||||
};
|
||||
|
||||
status = mmwlan_tx_wait_until_ready(1000);
|
||||
if (status != MMWLAN_SUCCESS) {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_SERIOUS, ("mmnetif: transmit blocked\n"));
|
||||
LINK_STATS_INC(link.drop);
|
||||
return ERR_BUF;
|
||||
}
|
||||
|
||||
pkt = mmwlan_alloc_mmpkt_for_tx(p->tot_len, metadata.tid);
|
||||
if (pkt == NULL) {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_SERIOUS, ("mmnetif: allocation failure\n"));
|
||||
LINK_STATS_INC(link.memerr);
|
||||
return ERR_MEM;
|
||||
}
|
||||
pktview = mmpkt_open(pkt);
|
||||
for (walk = p; walk != NULL; walk = walk->next) {
|
||||
mmpkt_append_data(pktview, (const uint8_t *)walk->payload, walk->len);
|
||||
}
|
||||
mmpkt_close(&pktview);
|
||||
|
||||
status = mmwlan_tx_pkt(pkt, &metadata);
|
||||
if (status != MMWLAN_SUCCESS) {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_SERIOUS, ("mmnetif: error sending packet\n"));
|
||||
LINK_STATS_INC(link.drop);
|
||||
return ERR_BUF;
|
||||
}
|
||||
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_ALL, ("mmnetif: packet sent\n"));
|
||||
LINK_STATS_INC(link.xmit);
|
||||
return ERR_OK;
|
||||
}
|
||||
|
||||
err_t mmnetif_init(struct netif *netif)
|
||||
{
|
||||
static bool initialised = false;
|
||||
if (initialised) {
|
||||
return ERR_IF;
|
||||
}
|
||||
|
||||
LWIP_MEMPOOL_INIT(RX_POOL);
|
||||
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_ALL, ("mmnetif: initialising mmnetif\n"));
|
||||
|
||||
#if LWIP_SNMP
|
||||
NETIF_INIT_SNMP(netif, snmp_ifType_ethernet_csmacd, 1000000UL);
|
||||
#endif
|
||||
|
||||
enum mmwlan_status status;
|
||||
|
||||
/* Boot the transceiver so that we can read the MAC address. */
|
||||
struct mmwlan_boot_args boot_args = MMWLAN_BOOT_ARGS_INIT;
|
||||
status = mmwlan_boot(&boot_args);
|
||||
if (status != MMWLAN_SUCCESS) {
|
||||
LWIP_DEBUGF(NETIF_DEBUG | LWIP_DBG_LEVEL_SEVERE, ("mmwlan_boot failed with code %d\n", status));
|
||||
}
|
||||
MMOSAL_ASSERT(status == MMWLAN_SUCCESS);
|
||||
|
||||
/* Set MAC hardware address */
|
||||
netif->hwaddr_len = MMWLAN_MAC_ADDR_LEN;
|
||||
status = mmwlan_get_mac_addr(netif->hwaddr);
|
||||
MMOSAL_ASSERT(status == MMWLAN_SUCCESS);
|
||||
|
||||
netif->mtu = 1500;
|
||||
#if LWIP_IPV4 && !LWIP_IPV6
|
||||
netif->flags |= NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_IGMP;
|
||||
#else
|
||||
netif->flags |= NETIF_FLAG_BROADCAST | NETIF_FLAG_ETHARP | NETIF_FLAG_IGMP | NETIF_FLAG_MLD6;
|
||||
#endif
|
||||
|
||||
netif->state = NULL;
|
||||
netif->name[0] = 'M';
|
||||
netif->name[1] = 'M';
|
||||
|
||||
#if LWIP_IPV4
|
||||
netif->output = etharp_output;
|
||||
#endif
|
||||
#if LWIP_IPV6
|
||||
netif->output_ip6 = ethip6_output;
|
||||
#endif
|
||||
netif->linkoutput = mmnetif_tx;
|
||||
|
||||
struct netif_state *state = (struct netif_state *)mmosal_malloc(sizeof(*state));
|
||||
MMOSAL_ASSERT(state != NULL);
|
||||
state->tx_qos_tid = MMWLAN_TX_DEFAULT_QOS_TID;
|
||||
netif->state = state;
|
||||
|
||||
status = mmwlan_register_rx_pkt_cb(mmnetif_rx, netif);
|
||||
MMOSAL_ASSERT(status == MMWLAN_SUCCESS);
|
||||
status = mmwlan_register_link_state_cb(mmnetif_link_state, netif);
|
||||
MMOSAL_ASSERT(status == MMWLAN_SUCCESS);
|
||||
|
||||
printf("Morse LwIP interface initialised. MAC address %02x:%02x:%02x:%02x:%02x:%02x\n", netif->hwaddr[0], netif->hwaddr[1],
|
||||
netif->hwaddr[2], netif->hwaddr[3], netif->hwaddr[4], netif->hwaddr[5]);
|
||||
|
||||
initialised = true;
|
||||
|
||||
return ERR_OK;
|
||||
}
|
||||
|
||||
void mmnetif_set_tx_qos_tid(struct netif *netif, uint8_t tid)
|
||||
{
|
||||
MMOSAL_ASSERT(tid <= MMWLAN_MAX_QOS_TID);
|
||||
get_netif_state(netif)->tx_qos_tid = tid;
|
||||
}
|
||||
|
||||
#endif
|
||||
@@ -0,0 +1,29 @@
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "lwip/err.h"
|
||||
#include "lwip/netif.h"
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/** Initializer for the Morse Micro network interface */
|
||||
err_t mmnetif_init(struct netif *netif);
|
||||
|
||||
/**
|
||||
* Configure the QoS TID for the @c netif. QoS data will be sent using this TID.
|
||||
*
|
||||
* @param netif The @c netif to configure.
|
||||
* @param tid The TID value to set.
|
||||
*/
|
||||
void mmnetif_set_tx_qos_tid(struct netif *netif, uint8_t tid);
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
@@ -0,0 +1,563 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include "esp_debug_helpers.h"
|
||||
#include "esp_private/startup_internal.h"
|
||||
#include "freertos/FreeRTOS.h"
|
||||
#include "freertos/queue.h"
|
||||
#include "freertos/semphr.h"
|
||||
#include "freertos/task.h"
|
||||
#include "freertos/timers.h"
|
||||
#include "rom/ets_sys.h"
|
||||
|
||||
#include "mmhal.h"
|
||||
#include "mmosal.h"
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
/** Maximum number of failure records to store (must be a power of 2). */
|
||||
#define MAX_FAILURE_RECORDS 4
|
||||
|
||||
/** Fast implementation of _x % _m where _m is a power of 2. */
|
||||
#define FAST_MOD(_x, _m) ((_x) & ((_m)-1))
|
||||
|
||||
/** Duration to delay before resetting the device on assert. */
|
||||
#define DELAY_BEFORE_RESET_MS 1000
|
||||
|
||||
/** Data structure for assertion information to be preserved. */
|
||||
struct mmosal_preserved_failure_info {
|
||||
/** Magic number, to check if the info is valid. */
|
||||
uint32_t magic;
|
||||
|
||||
/** Number of failures recorded. */
|
||||
uint32_t failure_count;
|
||||
|
||||
/** Number of most recently displayed failure. */
|
||||
uint32_t displayed_failure_count;
|
||||
|
||||
/** Preserved information from the most recent failure(s). */
|
||||
struct mmosal_failure_info info[MAX_FAILURE_RECORDS];
|
||||
};
|
||||
|
||||
/** Magic number to put in @c mmosal_assert_info.magic to indicate that the assertion info
|
||||
* is valid. */
|
||||
#define ASSERT_INFO_MAGIC (0xabcd1234)
|
||||
|
||||
/* Persistent assertion info. Linker script should put this into memory that is not
|
||||
* zeroed on boot. Be careful to update linker script if renaming. */
|
||||
struct mmosal_preserved_failure_info preserved_failure_info __attribute__((section(".noinit")));
|
||||
|
||||
void mmosal_log_failure_info(const struct mmosal_failure_info *info)
|
||||
{
|
||||
uint32_t record_num;
|
||||
|
||||
if (preserved_failure_info.magic != ASSERT_INFO_MAGIC) {
|
||||
preserved_failure_info.failure_count = 0;
|
||||
preserved_failure_info.displayed_failure_count = 0;
|
||||
}
|
||||
|
||||
preserved_failure_info.magic = ASSERT_INFO_MAGIC;
|
||||
record_num = FAST_MOD(preserved_failure_info.failure_count, MAX_FAILURE_RECORDS);
|
||||
preserved_failure_info.failure_count++;
|
||||
memcpy(&preserved_failure_info.info[record_num], info, sizeof(*info));
|
||||
}
|
||||
|
||||
static void mmosal_dump_failure_info(void)
|
||||
{
|
||||
unsigned first_failure_num = preserved_failure_info.displayed_failure_count;
|
||||
unsigned new_failure_count = preserved_failure_info.failure_count - preserved_failure_info.displayed_failure_count;
|
||||
unsigned failure_offset;
|
||||
|
||||
if (new_failure_count >= MAX_FAILURE_RECORDS) {
|
||||
first_failure_num = FAST_MOD(preserved_failure_info.failure_count, MAX_FAILURE_RECORDS);
|
||||
new_failure_count = MAX_FAILURE_RECORDS;
|
||||
}
|
||||
|
||||
for (failure_offset = 0; failure_offset < new_failure_count; failure_offset++) {
|
||||
unsigned ii;
|
||||
unsigned idx = FAST_MOD(first_failure_num + failure_offset, MAX_FAILURE_RECORDS);
|
||||
struct mmosal_failure_info *info = &preserved_failure_info.info[idx];
|
||||
|
||||
ets_printf("Failure %u logged at pc 0x%08lx, lr 0x%08lx, line %ld in %08lx\n", first_failure_num + failure_offset,
|
||||
info->pc, info->lr, info->line, info->fileid);
|
||||
|
||||
for (ii = 0; ii < sizeof(info->platform_info) / sizeof(info->platform_info[0]); ii++) {
|
||||
ets_printf(" 0x%08lx\n", info->platform_info[ii]);
|
||||
}
|
||||
}
|
||||
|
||||
preserved_failure_info.displayed_failure_count = preserved_failure_info.failure_count;
|
||||
}
|
||||
|
||||
void mmosal_impl_assert(void)
|
||||
{
|
||||
ets_printf("MMOSAL Assert, CPU %d (current core) backtrace", xPortGetCoreID());
|
||||
(void)esp_backtrace_print(100);
|
||||
#ifdef HALT_ON_ASSERT
|
||||
if (preserved_failure_info.magic == ASSERT_INFO_MAGIC) {
|
||||
mmosal_dump_failure_info();
|
||||
}
|
||||
mmosal_disable_interrupts();
|
||||
mmhal_log_flush();
|
||||
MMPORT_BREAKPOINT();
|
||||
#else
|
||||
mmosal_task_sleep(DELAY_BEFORE_RESET_MS);
|
||||
mmhal_reset();
|
||||
#endif
|
||||
while (1) {
|
||||
}
|
||||
}
|
||||
|
||||
/* Function to be called as part of the secondary initialization. See [System
|
||||
* Initialization](https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/api-guides/startup.html#system-initialization)
|
||||
* for more information. */
|
||||
ESP_SYSTEM_INIT_FN(mmosal_dump_failure_info, BIT(0), 999)
|
||||
{
|
||||
if (preserved_failure_info.magic == ASSERT_INFO_MAGIC) {
|
||||
mmosal_dump_failure_info();
|
||||
}
|
||||
return ESP_OK;
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
void *mmosal_malloc_(size_t size)
|
||||
{
|
||||
return pvPortMalloc(size);
|
||||
}
|
||||
|
||||
#ifdef MMOSAL_TRACK_ALLOCATIONS
|
||||
void *mmosal_malloc_dbg(size_t size, const char *name, unsigned line_number)
|
||||
{
|
||||
return pvPortMalloc_dbg(size, name, line_number);
|
||||
}
|
||||
#else
|
||||
void *mmosal_malloc_dbg(size_t size, const char *name, unsigned line_number)
|
||||
{
|
||||
(void)name;
|
||||
(void)line_number;
|
||||
return pvPortMalloc(size);
|
||||
}
|
||||
#endif
|
||||
|
||||
void mmosal_free(void *p)
|
||||
{
|
||||
vPortFree(p);
|
||||
}
|
||||
|
||||
void *mmosal_realloc(void *ptr, size_t size)
|
||||
{
|
||||
return realloc(ptr, size);
|
||||
}
|
||||
|
||||
void *mmosal_calloc(size_t nitems, size_t size)
|
||||
{
|
||||
void *ptr = pvPortMalloc(nitems * size);
|
||||
if (ptr == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
memset(ptr, 0, nitems * size);
|
||||
return ptr;
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_task_arg {
|
||||
mmosal_task_fn_t task_fn;
|
||||
void *task_fn_arg;
|
||||
};
|
||||
|
||||
void mmosal_task_main(void *arg)
|
||||
{
|
||||
struct mmosal_task_arg task_arg = *(struct mmosal_task_arg *)arg;
|
||||
mmosal_free(arg);
|
||||
task_arg.task_fn(task_arg.task_fn_arg);
|
||||
mmosal_task_delete(NULL);
|
||||
}
|
||||
|
||||
struct mmosal_task *mmosal_task_create(mmosal_task_fn_t task_fn, void *argument, enum mmosal_task_priority priority,
|
||||
unsigned stack_size_u32, const char *name)
|
||||
{
|
||||
TaskHandle_t handle;
|
||||
UBaseType_t freertos_priority = tskIDLE_PRIORITY + priority;
|
||||
|
||||
struct mmosal_task_arg *task_arg = (struct mmosal_task_arg *)mmosal_malloc(sizeof(*task_arg));
|
||||
if (task_arg == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
task_arg->task_fn = task_fn;
|
||||
task_arg->task_fn_arg = argument;
|
||||
|
||||
BaseType_t result = xTaskCreate(mmosal_task_main, name, stack_size_u32 * 4, task_arg, freertos_priority, &handle);
|
||||
if (result == pdFAIL) {
|
||||
mmosal_free(task_arg);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
return (struct mmosal_task *)handle;
|
||||
}
|
||||
|
||||
void mmosal_task_delete(struct mmosal_task *task)
|
||||
{
|
||||
vTaskDelete((TaskHandle_t)task);
|
||||
}
|
||||
|
||||
/*
|
||||
* Warning: this function should not be used since eTaskGetState() is not a reliable
|
||||
* means of testing whether a task has completed.
|
||||
*
|
||||
* This function will be removed in future.
|
||||
*/
|
||||
void mmosal_task_join(struct mmosal_task *task)
|
||||
{
|
||||
while (eTaskGetState((TaskHandle_t)task) != eDeleted) {
|
||||
mmosal_task_sleep(10);
|
||||
}
|
||||
}
|
||||
|
||||
struct mmosal_task *mmosal_task_get_active(void)
|
||||
{
|
||||
return (struct mmosal_task *)xTaskGetCurrentTaskHandle();
|
||||
}
|
||||
|
||||
void mmosal_task_yield(void)
|
||||
{
|
||||
taskYIELD();
|
||||
}
|
||||
|
||||
void mmosal_task_sleep(uint32_t duration_ms)
|
||||
{
|
||||
vTaskDelay(duration_ms / portTICK_PERIOD_MS);
|
||||
}
|
||||
|
||||
static portMUX_TYPE task_spinlock = portMUX_INITIALIZER_UNLOCKED;
|
||||
|
||||
void mmosal_task_enter_critical(void)
|
||||
{
|
||||
taskENTER_CRITICAL(&task_spinlock);
|
||||
}
|
||||
|
||||
void mmosal_task_exit_critical(void)
|
||||
{
|
||||
taskEXIT_CRITICAL(&task_spinlock);
|
||||
}
|
||||
|
||||
void mmosal_disable_interrupts(void)
|
||||
{
|
||||
taskDISABLE_INTERRUPTS();
|
||||
}
|
||||
|
||||
void mmosal_enable_interrupts(void)
|
||||
{
|
||||
taskENABLE_INTERRUPTS();
|
||||
}
|
||||
|
||||
const char *mmosal_task_name(void)
|
||||
{
|
||||
TaskHandle_t t = xTaskGetCurrentTaskHandle();
|
||||
return pcTaskGetName(t);
|
||||
}
|
||||
|
||||
bool mmosal_task_wait_for_notification(uint32_t timeout_ms)
|
||||
{
|
||||
TickType_t wait = portMAX_DELAY;
|
||||
if (timeout_ms < UINT32_MAX) {
|
||||
wait = pdMS_TO_TICKS(timeout_ms);
|
||||
}
|
||||
uint32_t ret = ulTaskNotifyTake(pdTRUE, /* Act as binary semaphore */
|
||||
wait);
|
||||
return (ret != 0);
|
||||
}
|
||||
|
||||
void mmosal_task_notify(struct mmosal_task *task)
|
||||
{
|
||||
xTaskNotifyGive((TaskHandle_t)task);
|
||||
}
|
||||
|
||||
void mmosal_task_notify_from_isr(struct mmosal_task *task)
|
||||
{
|
||||
BaseType_t higher_priority_task_woken = pdFALSE;
|
||||
vTaskNotifyGiveFromISR((TaskHandle_t)task, &higher_priority_task_woken);
|
||||
portYIELD_FROM_ISR(higher_priority_task_woken);
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_mutex *mmosal_mutex_create(const char *name)
|
||||
{
|
||||
struct mmosal_mutex *mutex = (struct mmosal_mutex *)xSemaphoreCreateMutex();
|
||||
#if (configUSE_TRACE_FACILITY == 1) && defined(ENABLE_TRACEALYZER) && ENABLE_TRACEALYZER
|
||||
if (name != NULL) {
|
||||
vTraceSetMutexName(mutex, name);
|
||||
}
|
||||
#else
|
||||
(void)name;
|
||||
#endif
|
||||
return mutex;
|
||||
}
|
||||
|
||||
void mmosal_mutex_delete(struct mmosal_mutex *mutex)
|
||||
{
|
||||
if (mutex != NULL) {
|
||||
vQueueDelete((SemaphoreHandle_t)mutex);
|
||||
}
|
||||
}
|
||||
|
||||
bool mmosal_mutex_get(struct mmosal_mutex *mutex, uint32_t timeout_ms)
|
||||
{
|
||||
uint32_t timeout_ticks = portMAX_DELAY;
|
||||
if (timeout_ms != UINT32_MAX) {
|
||||
timeout_ticks = timeout_ms / portTICK_PERIOD_MS;
|
||||
}
|
||||
return (xSemaphoreTake((SemaphoreHandle_t)mutex, timeout_ticks) == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_mutex_release(struct mmosal_mutex *mutex)
|
||||
{
|
||||
return (xSemaphoreGive((SemaphoreHandle_t)mutex) == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_mutex_is_held_by_active_task(struct mmosal_mutex *mutex)
|
||||
{
|
||||
return xSemaphoreGetMutexHolder((SemaphoreHandle_t)mutex) == xTaskGetCurrentTaskHandle();
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_sem *mmosal_sem_create(unsigned max_count, unsigned initial_count, const char *name)
|
||||
{
|
||||
struct mmosal_sem *sem = (struct mmosal_sem *)xSemaphoreCreateCounting(max_count, initial_count);
|
||||
#if (configUSE_TRACE_FACILITY == 1) && defined(ENABLE_TRACEALYZER) && ENABLE_TRACEALYZER
|
||||
if (name != NULL) {
|
||||
vTraceSetSemaphoreName(sem, name);
|
||||
}
|
||||
#else
|
||||
(void)name;
|
||||
#endif
|
||||
return sem;
|
||||
}
|
||||
|
||||
void mmosal_sem_delete(struct mmosal_sem *sem)
|
||||
{
|
||||
vQueueDelete((SemaphoreHandle_t)sem);
|
||||
}
|
||||
|
||||
bool mmosal_sem_give(struct mmosal_sem *sem)
|
||||
{
|
||||
return xSemaphoreGive((SemaphoreHandle_t)sem);
|
||||
}
|
||||
|
||||
bool mmosal_sem_give_from_isr(struct mmosal_sem *sem)
|
||||
{
|
||||
BaseType_t task_woken = false;
|
||||
BaseType_t ret = xSemaphoreGiveFromISR((SemaphoreHandle_t)sem, &task_woken);
|
||||
if (ret == pdPASS) {
|
||||
portYIELD_FROM_ISR(task_woken);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
bool mmosal_sem_wait(struct mmosal_sem *sem, uint32_t timeout_ms)
|
||||
{
|
||||
uint32_t timeout_ticks = portMAX_DELAY;
|
||||
if (timeout_ms != UINT32_MAX) {
|
||||
timeout_ticks = timeout_ms / portTICK_PERIOD_MS;
|
||||
}
|
||||
return (xSemaphoreTake((SemaphoreHandle_t)sem, timeout_ticks) == pdPASS);
|
||||
}
|
||||
|
||||
uint32_t mmosal_sem_get_count(struct mmosal_sem *sem)
|
||||
{
|
||||
return uxSemaphoreGetCount((SemaphoreHandle_t)sem);
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_semb *mmosal_semb_create(const char *name)
|
||||
{
|
||||
struct mmosal_semb *semb = (struct mmosal_semb *)xSemaphoreCreateBinary();
|
||||
#if (configUSE_TRACE_FACILITY == 1) && defined(ENABLE_TRACEALYZER) && ENABLE_TRACEALYZER
|
||||
if (name != NULL) {
|
||||
vTraceSetSemaphoreName(semb, name);
|
||||
}
|
||||
#else
|
||||
(void)name;
|
||||
#endif
|
||||
return semb;
|
||||
}
|
||||
|
||||
void mmosal_semb_delete(struct mmosal_semb *semb)
|
||||
{
|
||||
vQueueDelete((SemaphoreHandle_t)semb);
|
||||
}
|
||||
|
||||
bool mmosal_semb_give(struct mmosal_semb *semb)
|
||||
{
|
||||
return (xSemaphoreGive((SemaphoreHandle_t)semb) == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_semb_give_from_isr(struct mmosal_semb *semb)
|
||||
{
|
||||
BaseType_t task_woken = pdFALSE;
|
||||
BaseType_t ret = xSemaphoreGiveFromISR((SemaphoreHandle_t)semb, &task_woken);
|
||||
if (ret == pdPASS) {
|
||||
portYIELD_FROM_ISR(task_woken);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
bool mmosal_semb_wait(struct mmosal_semb *semb, uint32_t timeout_ms)
|
||||
{
|
||||
uint32_t timeout_ticks = portMAX_DELAY;
|
||||
if (timeout_ms != UINT32_MAX) {
|
||||
timeout_ticks = timeout_ms / portTICK_PERIOD_MS;
|
||||
}
|
||||
return (xSemaphoreTake((SemaphoreHandle_t)semb, timeout_ticks) == pdPASS);
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_queue *mmosal_queue_create(size_t num_items, size_t item_size, const char *name)
|
||||
{
|
||||
struct mmosal_queue *queue = (struct mmosal_queue *)xQueueCreate(num_items, item_size);
|
||||
#if (configUSE_TRACE_FACILITY == 1) && defined(ENABLE_TRACEALYZER) && ENABLE_TRACEALYZER
|
||||
if (name != NULL) {
|
||||
vTraceSetQueueName(queue, name);
|
||||
}
|
||||
#else
|
||||
(void)name;
|
||||
#endif
|
||||
return queue;
|
||||
}
|
||||
|
||||
void mmosal_queue_delete(struct mmosal_queue *queue)
|
||||
{
|
||||
vQueueDelete((SemaphoreHandle_t)queue);
|
||||
}
|
||||
|
||||
bool mmosal_queue_pop(struct mmosal_queue *queue, void *item, uint32_t timeout_ms)
|
||||
{
|
||||
uint32_t timeout_ticks = portMAX_DELAY;
|
||||
if (timeout_ms != UINT32_MAX) {
|
||||
timeout_ticks = timeout_ms / portTICK_PERIOD_MS;
|
||||
}
|
||||
return (xQueueReceive((SemaphoreHandle_t)queue, item, timeout_ticks) == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_queue_push(struct mmosal_queue *queue, const void *item, uint32_t timeout_ms)
|
||||
{
|
||||
uint32_t timeout_ticks = portMAX_DELAY;
|
||||
if (timeout_ms != UINT32_MAX) {
|
||||
timeout_ticks = timeout_ms / portTICK_PERIOD_MS;
|
||||
}
|
||||
return (xQueueSendToBack((SemaphoreHandle_t)queue, item, timeout_ticks) == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_queue_pop_from_isr(struct mmosal_queue *queue, void *item)
|
||||
{
|
||||
BaseType_t task_woken = pdFALSE;
|
||||
if (xQueueReceiveFromISR((SemaphoreHandle_t)queue, item, &task_woken) == pdTRUE) {
|
||||
portYIELD_FROM_ISR(task_woken);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
bool mmosal_queue_push_from_isr(struct mmosal_queue *queue, const void *item)
|
||||
{
|
||||
BaseType_t task_woken = pdFALSE;
|
||||
if (xQueueSendToBackFromISR((SemaphoreHandle_t)queue, item, &task_woken) == pdTRUE) {
|
||||
portYIELD_FROM_ISR(task_woken);
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
uint32_t mmosal_get_time_ms(void)
|
||||
{
|
||||
return xTaskGetTickCount() * portTICK_PERIOD_MS;
|
||||
}
|
||||
|
||||
uint32_t mmosal_get_time_ticks(void)
|
||||
{
|
||||
return xTaskGetTickCount();
|
||||
}
|
||||
|
||||
uint32_t mmosal_ticks_per_second(void)
|
||||
{
|
||||
return portTICK_PERIOD_MS * 1000;
|
||||
}
|
||||
|
||||
/* --------------------------------------------------------------------------------------------- */
|
||||
|
||||
struct mmosal_timer *mmosal_timer_create(const char *name, uint32_t timer_period, bool auto_reload, void *arg,
|
||||
timer_callback_t callback)
|
||||
{
|
||||
/*
|
||||
* The software timer callback functions execute in the context of a task that is
|
||||
* created automatically when the FreeRTOS scheduler is started. Therefore, it is essential that
|
||||
* software timer callback functions never call FreeRTOS API functions that will result in the
|
||||
* calling task entering the Blocked state. It is ok to call functions such as xQueueReceive(), but
|
||||
* only if the function’s xTicksToWait parameter (which specifies the function’s block time) is set
|
||||
* to 0. It is not ok to call functions such as vTaskDelay(), as calling vTaskDelay() will always
|
||||
* place the calling task into the Blocked state.
|
||||
*/
|
||||
return (struct mmosal_timer *)xTimerCreate(name, pdMS_TO_TICKS(timer_period), (UBaseType_t)auto_reload, arg,
|
||||
(TimerCallbackFunction_t)callback);
|
||||
}
|
||||
|
||||
void mmosal_timer_delete(struct mmosal_timer *timer)
|
||||
{
|
||||
if (timer != NULL) {
|
||||
BaseType_t ret = xTimerDelete((TimerHandle_t)timer, 0);
|
||||
configASSERT(ret == pdPASS);
|
||||
}
|
||||
}
|
||||
|
||||
bool mmosal_timer_start(struct mmosal_timer *timer)
|
||||
{
|
||||
BaseType_t ret = xTimerStart((TimerHandle_t)timer, 0);
|
||||
|
||||
return (ret == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_timer_stop(struct mmosal_timer *timer)
|
||||
{
|
||||
BaseType_t ret = xTimerStop((TimerHandle_t)timer, 0);
|
||||
|
||||
return (ret == pdPASS);
|
||||
}
|
||||
|
||||
bool mmosal_timer_change_period(struct mmosal_timer *timer, uint32_t new_period)
|
||||
{
|
||||
BaseType_t ret = xTimerChangePeriod((TimerHandle_t)timer, pdMS_TO_TICKS(new_period), 0);
|
||||
|
||||
return (ret == pdPASS);
|
||||
}
|
||||
|
||||
void *mmosal_timer_get_arg(struct mmosal_timer *timer)
|
||||
{
|
||||
return pvTimerGetTimerID((TimerHandle_t)timer);
|
||||
}
|
||||
|
||||
bool mmosal_is_timer_active(struct mmosal_timer *timer)
|
||||
{
|
||||
BaseType_t ret = xTimerIsTimerActive((TimerHandle_t)timer);
|
||||
|
||||
return (ret != pdFALSE);
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,245 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <stdatomic.h>
|
||||
#include <stdint.h>
|
||||
|
||||
#include "mmhal.h"
|
||||
#include "mmosal.h"
|
||||
#include "mmpkt.h"
|
||||
#include "mmpkt_list.h"
|
||||
#include "mmutils.h"
|
||||
|
||||
/* MMPKTMEM_TX_POOL_N_BLOCKS and MMPKTMEM_RX_POOL_N_BLOCKS provide an upper bound on the number
|
||||
* of packets we will allocate in the transmit and receive directions respectively. */
|
||||
|
||||
#ifndef MMPKTMEM_TX_POOL_N_BLOCKS
|
||||
#error MMPKTMEM_TX_POOL_N_BLOCKS not defined
|
||||
#endif
|
||||
|
||||
#ifndef MMPKTMEM_RX_POOL_N_BLOCKS
|
||||
#error MMPKTMEM_RX_POOL_N_BLOCKS not defined
|
||||
#endif
|
||||
|
||||
/* Packet pool for data/management frames configuration. */
|
||||
#define TX_DATA_POOL_UNPAUSE_THRESHOLD (MMPKTMEM_TX_POOL_N_BLOCKS - 2)
|
||||
#define TX_DATA_POOL_PAUSE_THRESHOLD (MMPKTMEM_TX_POOL_N_BLOCKS - 1)
|
||||
|
||||
/* Packet pool for commands configuration. */
|
||||
#define TX_COMMAND_POOL_BLOCK_SIZE (256)
|
||||
#define TX_COMMAND_POOL_N_BLOCKS (2)
|
||||
|
||||
#ifndef MMPKT_LOG
|
||||
#define MMPKT_LOG(...) printf(__VA_ARGS__)
|
||||
#endif
|
||||
|
||||
struct pktmem_data {
|
||||
/** Count of allocated tx packets (excluding command pool -- see below). */
|
||||
volatile atomic_int_least32_t tx_data_pool_allocated;
|
||||
/** Boolean tracking whether the data path is currently paused. */
|
||||
volatile atomic_uint_fast8_t tx_data_pool_tx_paused;
|
||||
/** Count of allocated rx packets. */
|
||||
volatile atomic_int_least32_t rx_pool_allocated;
|
||||
|
||||
/** Command pool free (unallocated) packet list. */
|
||||
struct mmpkt_list tx_command_pool_free_list;
|
||||
/** Statically allocated memory for the command pool. */
|
||||
uint8_t tx_command_pool[TX_COMMAND_POOL_BLOCK_SIZE * TX_COMMAND_POOL_N_BLOCKS];
|
||||
|
||||
/** Flow control callback function pointer. */
|
||||
mmhal_wlan_pktmem_tx_flow_control_cb_t tx_flow_control_cb;
|
||||
};
|
||||
|
||||
static struct pktmem_data pktmem;
|
||||
|
||||
void mmhal_wlan_pktmem_init(struct mmhal_wlan_pktmem_init_args *args)
|
||||
{
|
||||
unsigned ii;
|
||||
|
||||
memset(&pktmem, 0, sizeof(pktmem));
|
||||
|
||||
pktmem.tx_flow_control_cb = args->tx_flow_control_cb;
|
||||
|
||||
/* Initialize the free (unallocated) packet list of the transmit command pool. */
|
||||
for (ii = 0; ii < TX_COMMAND_POOL_N_BLOCKS; ii++) {
|
||||
size_t offset = TX_COMMAND_POOL_BLOCK_SIZE * ii;
|
||||
mmpkt_list_append(&pktmem.tx_command_pool_free_list, (struct mmpkt *)(pktmem.tx_command_pool + offset));
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_wlan_pktmem_deinit(void)
|
||||
{
|
||||
size_t ii;
|
||||
|
||||
/* If there is still memory allocated, allow some time for other threads to clean up. */
|
||||
for (ii = 0; ii < 100; ii++) {
|
||||
if ((pktmem.tx_command_pool_free_list.len | pktmem.tx_data_pool_allocated | pktmem.tx_data_pool_allocated) == 0) {
|
||||
break;
|
||||
}
|
||||
mmosal_task_sleep(10);
|
||||
}
|
||||
|
||||
/* Check for memory leaks. */
|
||||
if (pktmem.tx_data_pool_allocated != 0) {
|
||||
MMPKT_LOG("Potential memory leak: %d %s pool allocations at deinit\n", (int)pktmem.tx_data_pool_allocated, "data");
|
||||
}
|
||||
|
||||
if (pktmem.tx_command_pool_free_list.len != TX_COMMAND_POOL_N_BLOCKS) {
|
||||
MMPKT_LOG("Potential memory leak: %d %s pool allocations at deinit\n",
|
||||
TX_COMMAND_POOL_N_BLOCKS - (int)pktmem.tx_command_pool_free_list.len, "command");
|
||||
}
|
||||
}
|
||||
|
||||
/*
|
||||
* --------------------------------------------------------------------------------------
|
||||
* Command pool
|
||||
* --------------------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
static void tx_command_reserved_free(void *mmpkt)
|
||||
{
|
||||
struct mmpkt *pkt = (struct mmpkt *)mmpkt;
|
||||
MMOSAL_TASK_ENTER_CRITICAL();
|
||||
mmpkt_list_append(&pktmem.tx_command_pool_free_list, pkt);
|
||||
MMOSAL_TASK_EXIT_CRITICAL();
|
||||
}
|
||||
|
||||
static const struct mmpkt_ops tx_command_pool_ops = {
|
||||
.free_mmpkt = tx_command_reserved_free,
|
||||
};
|
||||
|
||||
static struct mmpkt *alloc_pkt_from_list(struct mmpkt_list *list, uint32_t pktbufsize, uint32_t space_at_start,
|
||||
uint32_t space_at_end, uint32_t metadata_length)
|
||||
{
|
||||
struct mmpkt *mmpkt_buf;
|
||||
struct mmpkt *mmpkt;
|
||||
|
||||
MMOSAL_TASK_ENTER_CRITICAL();
|
||||
mmpkt_buf = mmpkt_list_dequeue(list);
|
||||
MMOSAL_TASK_EXIT_CRITICAL();
|
||||
|
||||
if (mmpkt_buf == NULL) {
|
||||
return NULL;
|
||||
}
|
||||
|
||||
mmpkt = mmpkt_init_buf((uint8_t *)mmpkt_buf, pktbufsize, space_at_start, space_at_end, metadata_length, &tx_command_pool_ops);
|
||||
if (mmpkt == NULL) {
|
||||
/* Command was too big for the reserved buffer. Return the reserved buffer. */
|
||||
tx_command_reserved_free(mmpkt_buf);
|
||||
}
|
||||
|
||||
return mmpkt;
|
||||
}
|
||||
|
||||
static struct mmpkt *command_pool_alloc(uint32_t space_at_start, uint32_t space_at_end, uint32_t metadata_length)
|
||||
{
|
||||
return alloc_pkt_from_list(&pktmem.tx_command_pool_free_list, TX_COMMAND_POOL_BLOCK_SIZE, space_at_start, space_at_end,
|
||||
metadata_length);
|
||||
}
|
||||
|
||||
/*
|
||||
* --------------------------------------------------------------------------------------
|
||||
* Data pool
|
||||
* --------------------------------------------------------------------------------------
|
||||
*/
|
||||
|
||||
static void tx_data_pool_pkt_free(void *mmpkt)
|
||||
{
|
||||
atomic_int_least32_t old_value = atomic_fetch_sub(&pktmem.tx_data_pool_allocated, 1);
|
||||
MMOSAL_ASSERT(old_value > 0);
|
||||
mmosal_free(mmpkt);
|
||||
|
||||
if (pktmem.tx_data_pool_allocated < TX_DATA_POOL_UNPAUSE_THRESHOLD) {
|
||||
atomic_uint_fast8_t old_tx_paused = atomic_exchange(&pktmem.tx_data_pool_tx_paused, 0);
|
||||
if (old_tx_paused) {
|
||||
pktmem.tx_flow_control_cb(MMWLAN_TX_READY);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static const struct mmpkt_ops tx_data_pool_pkt_ops = {
|
||||
.free_mmpkt = tx_data_pool_pkt_free,
|
||||
};
|
||||
|
||||
struct mmpkt *mmhal_wlan_alloc_mmpkt_for_tx(uint8_t pkt_class, uint32_t space_at_start, uint32_t space_at_end,
|
||||
uint32_t metadata_length)
|
||||
{
|
||||
atomic_int_least32_t old_value;
|
||||
struct mmpkt *mmpkt;
|
||||
|
||||
/* For command packets, try allocating from the command pool first. If that fails then
|
||||
* we proceed to allocate from the data pool. */
|
||||
if (pkt_class == MMHAL_WLAN_PKT_COMMAND) {
|
||||
mmpkt = command_pool_alloc(space_at_start, space_at_end, metadata_length);
|
||||
if (mmpkt != NULL) {
|
||||
return mmpkt;
|
||||
}
|
||||
}
|
||||
|
||||
old_value = atomic_fetch_add(&pktmem.tx_data_pool_allocated, 1);
|
||||
|
||||
if (old_value >= MMPKTMEM_TX_POOL_N_BLOCKS) {
|
||||
/* Maximum allocations reached. Do not attempt to increase further. */
|
||||
atomic_fetch_sub(&pktmem.tx_data_pool_allocated, 1);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
mmpkt = mmpkt_alloc_on_heap(space_at_start, space_at_end, metadata_length);
|
||||
if (mmpkt == NULL) {
|
||||
atomic_fetch_sub(&pktmem.tx_data_pool_allocated, 1);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
mmpkt->ops = &tx_data_pool_pkt_ops;
|
||||
|
||||
if (pktmem.tx_data_pool_allocated > TX_DATA_POOL_PAUSE_THRESHOLD) {
|
||||
atomic_uint_fast8_t old_tx_paused = atomic_exchange(&pktmem.tx_data_pool_tx_paused, 1);
|
||||
if (!old_tx_paused) {
|
||||
pktmem.tx_flow_control_cb(MMWLAN_TX_PAUSED);
|
||||
}
|
||||
}
|
||||
|
||||
return mmpkt;
|
||||
}
|
||||
|
||||
static void rx_pkt_free(void *mmpkt)
|
||||
{
|
||||
if (mmpkt != NULL) {
|
||||
atomic_fetch_sub(&pktmem.rx_pool_allocated, 1);
|
||||
mmosal_free(mmpkt);
|
||||
}
|
||||
}
|
||||
|
||||
static const struct mmpkt_ops mmpkt_rx_ops = {.free_mmpkt = rx_pkt_free};
|
||||
|
||||
struct mmpkt *mmhal_wlan_alloc_mmpkt_for_rx(uint32_t capacity, uint32_t metadata_length)
|
||||
{
|
||||
atomic_int_least32_t old_value;
|
||||
struct mmpkt *mmpkt;
|
||||
|
||||
old_value = atomic_fetch_add(&pktmem.rx_pool_allocated, 1);
|
||||
|
||||
if (old_value >= MMPKTMEM_RX_POOL_N_BLOCKS) {
|
||||
/* Maximum allocations reached. Do not attempt to increase further. */
|
||||
atomic_fetch_sub(&pktmem.rx_pool_allocated, 1);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* For now we do not put an explicit limit on the of packets buffers on the RX path. */
|
||||
mmpkt = mmpkt_alloc_on_heap(0, capacity, metadata_length);
|
||||
if (mmpkt == NULL) {
|
||||
atomic_fetch_sub(&pktmem.rx_pool_allocated, 1);
|
||||
return NULL;
|
||||
}
|
||||
|
||||
/* Override packet ops to use a custom free function that also decrements the
|
||||
* allocation count. */
|
||||
mmpkt->ops = &mmpkt_rx_ops;
|
||||
return mmpkt;
|
||||
}
|
||||
|
||||
#endif
|
||||
@@ -0,0 +1,12 @@
|
||||
/*
|
||||
* Copyright 2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#define MMPORT_BREAKPOINT() while (1)
|
||||
#define MMPORT_GET_LR() (__builtin_return_address(0))
|
||||
#define MMPORT_GET_PC(_a) ((_a) = 0) // TODO
|
||||
#define MMPORT_MEM_SYNC() __sync_synchronize()
|
||||
@@ -0,0 +1,301 @@
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup MMUTILS Morse Micro Utilities
|
||||
*
|
||||
* Utility macros and functions to improve quality of life.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <stdarg.h>
|
||||
#include <stdbool.h>
|
||||
#include <stdint.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Get the minimum of 2 values.
|
||||
*
|
||||
* Note that this macro is not ideal and should be used with caution. Caveats include:
|
||||
* * The two parameters may be evaluated more than once, so should be constant values that
|
||||
* do not have side effects. For example, do NOT do `MM_MIN(a++, b)`.
|
||||
* * There are no explicit constraints on types, so be careful of comparing different integer
|
||||
* types, etc.
|
||||
*
|
||||
* @param _x The first value to compare.
|
||||
* @param _y The second value to compare.
|
||||
*
|
||||
* @returns the minimum of @p _x and @p _y.
|
||||
*/
|
||||
#define MM_MIN(_x, _y) (((_x) < (_y)) ? (_x) : (_y))
|
||||
|
||||
/**
|
||||
* Get the maximum of 2 values.
|
||||
*
|
||||
* Note that this macro is not ideal and should be used with caution. Caveats include:
|
||||
* * The two parameters may be evaluated more than once, so should be constant values that
|
||||
* do not have side effects. For example, do NOT do `MM_MAX(a++, b)`.
|
||||
* * There are no explicit constraints on types, so be careful of comparing different integer
|
||||
* types, etc.
|
||||
*
|
||||
* @param _x The first value to compare.
|
||||
* @param _y The second value to compare.
|
||||
*
|
||||
* @returns the maximum of @p _x and @p _y.
|
||||
*/
|
||||
#define MM_MAX(_x, _y) (((_x) > (_y)) ? (_x) : (_y))
|
||||
|
||||
/**
|
||||
* Round @p x up to the next multiple of @p m (where @p m is a power of 2).
|
||||
*
|
||||
* @warning @p m must be a power of 2.
|
||||
*/
|
||||
#ifndef MM_FAST_ROUND_UP
|
||||
#define MM_FAST_ROUND_UP(x, m) ((((x)-1) | ((m)-1)) + 1)
|
||||
#endif
|
||||
|
||||
/** Casts the given expression to void to avoid "unused" warnings from the compiler. */
|
||||
#define MM_UNUSED(_x) (void)(_x)
|
||||
|
||||
/** Tells the compiler to pack the structure. */
|
||||
#ifndef MM_PACKED
|
||||
#define MM_PACKED __attribute__((packed))
|
||||
#endif
|
||||
|
||||
/** Used to declare a weak symbol. */
|
||||
#ifndef MM_WEAK
|
||||
#define MM_WEAK __attribute__((weak))
|
||||
#endif
|
||||
|
||||
#ifndef MM_STATIC_ASSERT
|
||||
/**
|
||||
* Assertion check that is evaluated at compile time.
|
||||
*
|
||||
* The constant expression, @p _expression, is evaluted at compile time. If zero then
|
||||
* it triggers a compilation error and @p _message is displayed. If non-zero, no code
|
||||
* is emitted.
|
||||
*
|
||||
* @param _expression Constant expression to evaluate. If zero then a compilation error
|
||||
* is triggered.
|
||||
* @param _message Message to display on error.
|
||||
*/
|
||||
#define MM_STATIC_ASSERT(_expression, _message) _Static_assert((_expression), _message)
|
||||
#endif
|
||||
|
||||
/**
|
||||
* Return the number of elements in the given array.
|
||||
*
|
||||
* @param _a The array to get the element count for. Note that this must be an _array_
|
||||
* and not a pointer. Beware that array-type function arguments are
|
||||
* actually treated as pointers by the compiler. Must not be NULL.
|
||||
*
|
||||
* @returns the count of elements in the given array.
|
||||
*/
|
||||
#define MM_ARRAY_COUNT(_a) (sizeof(_a) / sizeof((_a)[0]))
|
||||
|
||||
/**
|
||||
* Convert the least significant 4 bits of the given argument to a character representing their
|
||||
* hexadecimal value.
|
||||
*
|
||||
* For example, for input 0xde this will return 'E', for 0x01 it will return '1'.
|
||||
*
|
||||
* @param nibble The input nibble (upper 4 bits will be discarded).
|
||||
*
|
||||
* @return The character that represents the hexadecimal value of the lower 4 bits of @p nibble.
|
||||
* Values greater than 0x09 will be represented with upper case characters.
|
||||
*/
|
||||
static inline char mm_nibble_to_hex_char(uint8_t nibble)
|
||||
{
|
||||
nibble &= 0x0f;
|
||||
if (nibble < 0x0a) {
|
||||
return '0' + nibble;
|
||||
} else {
|
||||
return 'A' + nibble - 0x0a;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @defgroup MMUTILS_WLAN WLAN Utilities
|
||||
*
|
||||
* Utility macros and functions relating to WLAN.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
/** Enumeration of Authentication Key Management (AKM) Suite OUIs as BE32 integers. */
|
||||
enum mm_akm_suite_oui {
|
||||
/** Open (no security) */
|
||||
MM_AKM_SUITE_NONE = 0,
|
||||
/** Pre-shared key (WFA OUI) */
|
||||
MM_AKM_SUITE_PSK = 0x506f9a02,
|
||||
/** Simultaneous Authentication of Equals (SAE) */
|
||||
MM_AKM_SUITE_SAE = 0x000fac08,
|
||||
/** OWE */
|
||||
MM_AKM_SUITE_OWE = 0x000fac12,
|
||||
/** Another suite not in this enum */
|
||||
MM_AKM_SUITE_OTHER = 1,
|
||||
};
|
||||
|
||||
/** Enumeration of Cipher Suite OUIs as BE32 integers. */
|
||||
enum mm_cipher_suite_oui {
|
||||
/** Open (no security) */
|
||||
MM_CIPHER_SUITE_AES_CCM = 0x000fac04,
|
||||
/** Another cipher suite not in this enum */
|
||||
MM_CIPHER_SUITE_OTHER = 1,
|
||||
};
|
||||
|
||||
/** Maximum number of pairwise cipher suites our parser will process. */
|
||||
#ifndef MM_RSN_INFORMATION_MAX_PAIRWISE_CIPHER_SUITES
|
||||
#define MM_RSN_INFORMATION_MAX_PAIRWISE_CIPHER_SUITES (2)
|
||||
#endif
|
||||
|
||||
/** Maximum number of AKM suites our parser will process. */
|
||||
#ifndef MM_RSN_INFORMATION_MAX_AKM_SUITES
|
||||
#define MM_RSN_INFORMATION_MAX_AKM_SUITES (2)
|
||||
#endif
|
||||
|
||||
/** Tag number of the RSN information element, in which we can find security details of the AP. */
|
||||
#define MM_RSN_INFORMATION_IE_TYPE (48)
|
||||
/** Tag number of the Vendor Specific information element. */
|
||||
#define MM_VENDOR_SPECIFIC_IE_TYPE (221)
|
||||
|
||||
/** Explicitly defined errno values to obviate the need to include errno.h. MM prefix to
|
||||
* avoid namespace collision in case errno.h gets included. */
|
||||
enum mm_errno {
|
||||
MM_ENOMEM = 12,
|
||||
MM_EFAULT = 14,
|
||||
MM_ENODEV = 19,
|
||||
MM_EINVAL = 22,
|
||||
MM_ETIMEDOUT = 110,
|
||||
};
|
||||
|
||||
/**
|
||||
* Data structure to represent information extracted from an RSN information element.
|
||||
*
|
||||
* All integers in host order.
|
||||
*/
|
||||
struct mm_rsn_information {
|
||||
/** The group cipher suite OUI. */
|
||||
uint32_t group_cipher_suite;
|
||||
/** Pairwise cipher suite OUIs. Count given by @c num_pairwise_cipher_suites. */
|
||||
uint32_t pairwise_cipher_suites[MM_RSN_INFORMATION_MAX_PAIRWISE_CIPHER_SUITES];
|
||||
/** AKM suite OUIs. Count given by @c num_akm_suites. */
|
||||
uint32_t akm_suites[MM_RSN_INFORMATION_MAX_AKM_SUITES];
|
||||
/** Number of pairwise cipher suites in @c pairwise_cipher_suites. */
|
||||
uint16_t num_pairwise_cipher_suites;
|
||||
/** Number of AKM suites in @c akm_suites. */
|
||||
uint16_t num_akm_suites;
|
||||
/** Version number of the RSN IE. */
|
||||
uint16_t version;
|
||||
/** RSN Capabilities field of the RSN IE (in host order). */
|
||||
uint16_t rsn_capabilities;
|
||||
};
|
||||
|
||||
/**
|
||||
* Get the name of the given AKM Suite as a string.
|
||||
*
|
||||
* @param akm_suite_oui The OUI of the AKM suite as a big endian integer.
|
||||
*
|
||||
* @returns the string representation.
|
||||
*/
|
||||
const char *mm_akm_suite_to_string(uint32_t akm_suite_oui);
|
||||
|
||||
/**
|
||||
* Search a list of Information Elements (IEs) from the given starting offset and find the first
|
||||
* instance of matching the given type.
|
||||
*
|
||||
* @warning A @p search_offset that is not aligned to the start of an IE header will result in
|
||||
* undefined behaviour.
|
||||
*
|
||||
* @param ies Buffer containing the information elements.
|
||||
* @param ies_len Length of @p ies
|
||||
* @param search_offset Offset to start searching from. This **must** point to a IE header.
|
||||
* @param ie_type The type of the IE to look for.
|
||||
*
|
||||
* @return If the information element is found, the offset of the start of the IE within @p ies; if
|
||||
* no match is found then -1; if the IE is found but is malformed then -2.
|
||||
*/
|
||||
int mm_find_ie_from_offset(const uint8_t *ies, uint32_t ies_len, uint32_t search_offset, uint8_t ie_type);
|
||||
|
||||
/**
|
||||
* Search a list of Information Elements (IEs) and find the first instance of matching the
|
||||
* given type.
|
||||
*
|
||||
* @param ies Buffer containing the information elements.
|
||||
* @param ies_len Length of @p ies
|
||||
* @param ie_type The type of the IE to look for.
|
||||
*
|
||||
* @return If the information element is found, the offset of the start of the IE within @p ies;
|
||||
* if no match is found then -1; if the IE is found but is malformed then -2.
|
||||
*/
|
||||
static inline int mm_find_ie(const uint8_t *ies, uint32_t ies_len, uint8_t ie_type)
|
||||
{
|
||||
return mm_find_ie_from_offset(ies, ies_len, 0, ie_type);
|
||||
}
|
||||
|
||||
/**
|
||||
* Search through the given list of Information Elements (IEs) from the given starting offset to
|
||||
* find the first Vendor Specific IE that matches the given id.
|
||||
*
|
||||
* @warning A @p search_offset that is not aligned to the start of an IE header will result in
|
||||
* undefined behaviour.
|
||||
*
|
||||
* @param[in] ies Buffer containing the information elements.
|
||||
* @param[in] ies_len Length of @p ies
|
||||
* @param[in] search_offset Offset to start searching from. This **must** point to a IE header.
|
||||
* @param[in] id Buffer containing the IE ID, usually OUI+TYPE.
|
||||
* @param[in] id_len Length of the ID.
|
||||
*
|
||||
* @return If the information element is found, the offset of the start of the IE within @p ies; if
|
||||
* no match is found then -1; if the IE is found but is malformed then -2.
|
||||
*/
|
||||
int mm_find_vendor_specific_ie_from_offset(const uint8_t *ies, uint32_t ies_len, uint32_t search_offset, const uint8_t *id,
|
||||
size_t id_len);
|
||||
|
||||
/**
|
||||
* Search through the given list of Information Elements (IEs) to find the first Vendor Specific IE
|
||||
* that matches the given id.
|
||||
*
|
||||
* @param[in] ies Buffer containing the information elements.
|
||||
* @param[in] ies_len Length of @p ies
|
||||
* @param[in] id Buffer containing the IE ID, usually OUI+TYPE.
|
||||
* @param[in] id_len Length of the ID.
|
||||
*
|
||||
* @return If the information element is found, the offset of the start of the IE within @p ies; if
|
||||
* no match is found then -1; if the IE is found but is malformed then -2.
|
||||
*/
|
||||
static inline int mm_find_vendor_specific_ie(const uint8_t *ies, uint32_t ies_len, const uint8_t *id, size_t id_len)
|
||||
{
|
||||
return mm_find_vendor_specific_ie_from_offset(ies, ies_len, 0, id, id_len);
|
||||
}
|
||||
|
||||
/**
|
||||
* Search through the given list of information elements to find the RSN IE then parse it
|
||||
* to extract relevant information into an instance of @ref mm_rsn_information.
|
||||
*
|
||||
* @param[in] ies Buffer containing the information elements.
|
||||
* @param[in] ies_len Length of @p ies
|
||||
* @param[out] output Pointer to an instance of @ref mm_rsn_information to receive output.
|
||||
*
|
||||
* @returns -2 on parse error, -1 if the RSN IE was not found, 0 if the RSN IE was found.
|
||||
*/
|
||||
int mm_parse_rsn_information(const uint8_t *ies, uint32_t ies_len, struct mm_rsn_information *output);
|
||||
|
||||
/** @} */
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
/** @} */
|
||||
@@ -0,0 +1,163 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2024 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
||||
#include <stdio.h>
|
||||
|
||||
#include "mmutils.h"
|
||||
|
||||
const char *mm_akm_suite_to_string(uint32_t akm_suite_oui)
|
||||
{
|
||||
switch (akm_suite_oui) {
|
||||
case MM_AKM_SUITE_NONE:
|
||||
return "None";
|
||||
|
||||
case MM_AKM_SUITE_PSK:
|
||||
return "PSK";
|
||||
|
||||
case MM_AKM_SUITE_SAE:
|
||||
return "SAE";
|
||||
|
||||
case MM_AKM_SUITE_OWE:
|
||||
return "OWE";
|
||||
|
||||
default:
|
||||
return "Other";
|
||||
}
|
||||
}
|
||||
|
||||
int mm_find_ie_from_offset(const uint8_t *ies, uint32_t ies_len, uint32_t search_offset, uint8_t ie_type)
|
||||
{
|
||||
while ((search_offset + 2) <= ies_len) {
|
||||
uint8_t type = ies[search_offset];
|
||||
uint8_t length = ies[search_offset + 1];
|
||||
|
||||
if (type == ie_type) {
|
||||
if ((search_offset + 2 + length) > ies_len) {
|
||||
return -2;
|
||||
}
|
||||
return search_offset;
|
||||
}
|
||||
|
||||
search_offset += 2 + length;
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
int mm_find_vendor_specific_ie_from_offset(const uint8_t *ies, uint32_t ies_len, uint32_t search_offset, const uint8_t *id,
|
||||
size_t id_len)
|
||||
{
|
||||
int offset = 0;
|
||||
|
||||
while ((search_offset + id_len) <= ies_len) {
|
||||
offset = mm_find_ie_from_offset(ies, ies_len, search_offset, MM_VENDOR_SPECIFIC_IE_TYPE);
|
||||
if (offset < 0) {
|
||||
return offset;
|
||||
}
|
||||
|
||||
uint8_t ie_type = ies[offset];
|
||||
uint8_t ie_length = ies[offset + 1];
|
||||
const uint8_t *ie_data = ies + (offset + 2);
|
||||
|
||||
if (ie_type == MM_VENDOR_SPECIFIC_IE_TYPE && id_len <= ie_length && (memcmp(id, ie_data, id_len) == 0)) {
|
||||
if (((uint32_t)offset + 2 + ie_length) > ies_len) {
|
||||
return -2;
|
||||
}
|
||||
return offset;
|
||||
}
|
||||
|
||||
search_offset = 2 + ie_length + (uint32_t)offset;
|
||||
}
|
||||
|
||||
return -1;
|
||||
}
|
||||
|
||||
int mm_parse_rsn_information(const uint8_t *ies, uint32_t ies_len, struct mm_rsn_information *output)
|
||||
{
|
||||
uint8_t length;
|
||||
uint16_t num_pairwise_cipher_suites;
|
||||
uint16_t num_akm_suites;
|
||||
uint16_t ii;
|
||||
|
||||
int offset = mm_find_ie(ies, ies_len, MM_RSN_INFORMATION_IE_TYPE);
|
||||
|
||||
memset(output, 0, sizeof(*output));
|
||||
|
||||
if (offset < 0) {
|
||||
return offset;
|
||||
}
|
||||
|
||||
/* Note that we rely on mm_find_ie() to validate that the IE does not extend past the end
|
||||
* of the given buffer. */
|
||||
|
||||
length = ies[offset + 1];
|
||||
offset += 2;
|
||||
|
||||
if (length < 8) {
|
||||
printf("*WRN* RSN IE too short\n");
|
||||
return -2;
|
||||
}
|
||||
|
||||
/* Skip version field */
|
||||
output->version = ies[offset] | ies[offset + 1] << 8;
|
||||
offset += 2;
|
||||
length -= 2;
|
||||
|
||||
output->group_cipher_suite = ies[offset] << 24 | ies[offset + 1] << 16 | ies[offset + 2] << 8 | ies[offset + 3];
|
||||
offset += 4;
|
||||
length -= 4;
|
||||
|
||||
num_pairwise_cipher_suites = ies[offset] | ies[offset + 1] << 8;
|
||||
offset += 2;
|
||||
length -= 2;
|
||||
|
||||
output->num_pairwise_cipher_suites = num_pairwise_cipher_suites;
|
||||
if (num_pairwise_cipher_suites > MM_RSN_INFORMATION_MAX_PAIRWISE_CIPHER_SUITES) {
|
||||
output->num_pairwise_cipher_suites = MM_RSN_INFORMATION_MAX_PAIRWISE_CIPHER_SUITES;
|
||||
}
|
||||
|
||||
if (length < 4 * num_pairwise_cipher_suites + 2) {
|
||||
printf("*WRN* RSN IE too short\n");
|
||||
return -2;
|
||||
}
|
||||
|
||||
for (ii = 0; ii < num_pairwise_cipher_suites; ii++) {
|
||||
if (ii < output->num_pairwise_cipher_suites) {
|
||||
output->pairwise_cipher_suites[ii] =
|
||||
ies[offset] << 24 | ies[offset + 1] << 16 | ies[offset + 2] << 8 | ies[offset + 3];
|
||||
}
|
||||
offset += 4;
|
||||
length -= 4;
|
||||
}
|
||||
|
||||
num_akm_suites = ies[offset] | ies[offset + 1] << 8;
|
||||
offset += 2;
|
||||
length -= 2;
|
||||
|
||||
output->num_akm_suites = num_akm_suites;
|
||||
if (num_akm_suites > MM_RSN_INFORMATION_MAX_AKM_SUITES) {
|
||||
output->num_akm_suites = MM_RSN_INFORMATION_MAX_AKM_SUITES;
|
||||
}
|
||||
|
||||
if (length < 4 * num_akm_suites + 2) {
|
||||
printf("*WRN* RSN IE too short\n");
|
||||
return -2;
|
||||
}
|
||||
|
||||
for (ii = 0; ii < num_akm_suites; ii++) {
|
||||
if (ii < output->num_akm_suites) {
|
||||
output->akm_suites[ii] = ies[offset] << 24 | ies[offset + 1] << 16 | ies[offset + 2] << 8 | ies[offset + 3];
|
||||
}
|
||||
offset += 4;
|
||||
length -= 4;
|
||||
}
|
||||
|
||||
output->rsn_capabilities = ies[offset] | ies[offset + 1] << 8;
|
||||
return 0;
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,267 @@
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
/*
|
||||
* Copyright 2021-2023 Morse Micro
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
#include <inttypes.h>
|
||||
#include <stdio.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
#include "mmhal.h"
|
||||
#include "mmosal.h"
|
||||
|
||||
#include "driver/gpio.h"
|
||||
#include "driver/spi_common.h"
|
||||
#include "driver/spi_master.h"
|
||||
#include "esp_random.h"
|
||||
#include "esp_system.h"
|
||||
|
||||
/** 10x8bit training seq */
|
||||
#define BYTE_TRAIN 16
|
||||
|
||||
/** SPI hw interrupt handler. Must be set before enabling irq */
|
||||
static mmhal_irq_handler_t spi_irq_handler = NULL;
|
||||
|
||||
/** busy interrupt handler. Must be set before enabling irq */
|
||||
static mmhal_irq_handler_t busy_irq_handler = NULL;
|
||||
|
||||
static spi_device_handle_t spi_handle;
|
||||
|
||||
static void wlan_hal_gpio_init(void)
|
||||
{
|
||||
gpio_config_t io_conf = {};
|
||||
io_conf.intr_type = GPIO_INTR_DISABLE;
|
||||
io_conf.mode = GPIO_MODE_OUTPUT;
|
||||
io_conf.pin_bit_mask = ((1ull << CONFIG_MM_WAKE) | (1ull << CONFIG_MM_SPI_CS));
|
||||
io_conf.pull_down_en = 0;
|
||||
io_conf.pull_up_en = 0;
|
||||
gpio_config(&io_conf);
|
||||
|
||||
gpio_set_level(CONFIG_MM_WAKE, 0);
|
||||
gpio_set_level(CONFIG_MM_SPI_CS, 0);
|
||||
|
||||
io_conf.intr_type = GPIO_INTR_DISABLE;
|
||||
io_conf.mode = GPIO_MODE_INPUT;
|
||||
io_conf.pin_bit_mask = (1ull << CONFIG_MM_BUSY);
|
||||
io_conf.pull_down_en = 1;
|
||||
gpio_config(&io_conf);
|
||||
|
||||
io_conf.intr_type = GPIO_INTR_DISABLE;
|
||||
io_conf.mode = GPIO_MODE_INPUT;
|
||||
io_conf.pin_bit_mask = (1ull << CONFIG_MM_SPI_IRQ);
|
||||
io_conf.pull_down_en = 0;
|
||||
gpio_config(&io_conf);
|
||||
}
|
||||
|
||||
static void wlan_hal_spi_init(void)
|
||||
{
|
||||
esp_err_t ret;
|
||||
|
||||
spi_bus_config_t buscfg = {
|
||||
.miso_io_num = CONFIG_MM_SPI_MISO,
|
||||
.mosi_io_num = CONFIG_MM_SPI_MOSI,
|
||||
.sclk_io_num = CONFIG_MM_SPI_SCK,
|
||||
.quadwp_io_num = -1,
|
||||
.quadhd_io_num = -1,
|
||||
/* max_transfer_sz defaults to 4092 if 0 when DMA enabled, or to SOC_SPI_MAXIMUM_BUFFER_SIZE
|
||||
* if DMA is disabled. */
|
||||
.max_transfer_sz = 0,
|
||||
.flags = SPICOMMON_BUSFLAG_MASTER,
|
||||
};
|
||||
ret = spi_bus_initialize(SPI2_HOST, &buscfg, SPI_DMA_CH_AUTO);
|
||||
if (ret != ESP_OK) {
|
||||
printf("spi_bus_initialize failed\n");
|
||||
}
|
||||
|
||||
/* Selected the highest available SPI clock speed that is still below the MM6108's maximum of
|
||||
* 50MHz */
|
||||
spi_device_interface_config_t dev_cfg = {
|
||||
.clock_speed_hz = SPI_MASTER_FREQ_40M,
|
||||
.mode = 0,
|
||||
.spics_io_num = -1,
|
||||
.queue_size = 1,
|
||||
};
|
||||
ret = spi_bus_add_device(SPI2_HOST, &dev_cfg, &spi_handle);
|
||||
if (ret != ESP_OK) {
|
||||
printf("spi_bus_add_device failed\n");
|
||||
}
|
||||
|
||||
/* The actual clock frequency may not be the one that was set as it is re-calculated by the
|
||||
* driver to the nearest hardware-compatible number. Importantly it is the "nearest", so it could be above
|
||||
* the value set. */
|
||||
int actual_freq_khz = 0;
|
||||
spi_device_get_actual_freq(spi_handle, &actual_freq_khz);
|
||||
printf("Actual SPI CLK %dkHz\n", actual_freq_khz);
|
||||
}
|
||||
|
||||
static void wlan_hal_spi_deinit(void)
|
||||
{
|
||||
esp_err_t ret = spi_bus_remove_device(spi_handle);
|
||||
if (ret != ESP_OK) {
|
||||
printf("spi_bus_remove_device failed\n");
|
||||
}
|
||||
|
||||
ret = spi_bus_free(SPI2_HOST);
|
||||
if (ret != ESP_OK) {
|
||||
printf("spi_bus_initialize failed\n");
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Minium transfer length in bytes before interrupt based transactions are used. This is because
|
||||
* there is some setup time associated with using the interrupt based method when compared to the
|
||||
* polling method. In the cases where the difference in setup time exceeds the transaction duration
|
||||
* it is more efficient to uses the polling method instead of the interrupt based one. The below
|
||||
* equation was used to calculate this.
|
||||
*
|
||||
* (DMA_TRANSACTION_DURATION - POLL_TRANSACTION_DURATION) / (8/SPI_FREQ)
|
||||
*
|
||||
* The typical duration for the ESP32 can be found in the [transaction
|
||||
* duration](https://docs.espressif.com/projects/esp-idf/en/v5.1.1/esp32s3/api-reference/peripherals/spi_master.html#transaction-duration)
|
||||
* section of the docs.
|
||||
*/
|
||||
#define INTERRUPT_TRANSFER_MIN_LENGTH 75
|
||||
|
||||
static void spi_master_rw(const uint8_t *w_data, uint8_t *r_data, size_t len)
|
||||
{
|
||||
spi_transaction_t trans_desc = {
|
||||
.rx_buffer = r_data,
|
||||
.tx_buffer = w_data,
|
||||
.length = (len * 8),
|
||||
.flags = 0,
|
||||
};
|
||||
|
||||
esp_err_t err;
|
||||
if (len < INTERRUPT_TRANSFER_MIN_LENGTH) {
|
||||
err = spi_device_polling_transmit(spi_handle, &trans_desc);
|
||||
} else {
|
||||
err = spi_device_transmit(spi_handle, &trans_desc);
|
||||
}
|
||||
|
||||
if (err != ESP_OK) {
|
||||
printf("SPI rw error = %x\n", err);
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_wlan_hard_reset(void)
|
||||
{
|
||||
gpio_set_level(CONFIG_MM_RESET_N, 0);
|
||||
mmosal_task_sleep(5);
|
||||
gpio_set_level(CONFIG_MM_RESET_N, 1);
|
||||
mmosal_task_sleep(20);
|
||||
}
|
||||
|
||||
void mmhal_wlan_spi_cs_assert(void)
|
||||
{
|
||||
gpio_set_level(CONFIG_MM_SPI_CS, 0);
|
||||
}
|
||||
|
||||
void mmhal_wlan_spi_cs_deassert(void)
|
||||
{
|
||||
gpio_set_level(CONFIG_MM_SPI_CS, 1);
|
||||
}
|
||||
|
||||
uint8_t mmhal_wlan_spi_rw(uint8_t data)
|
||||
{
|
||||
uint8_t readval;
|
||||
spi_master_rw(&data, &readval, 1);
|
||||
return readval;
|
||||
}
|
||||
|
||||
void mmhal_wlan_spi_read_buf(uint8_t *buf, unsigned len)
|
||||
{
|
||||
spi_master_rw(NULL, buf, len);
|
||||
}
|
||||
|
||||
void mmhal_wlan_spi_write_buf(const uint8_t *buf, unsigned len)
|
||||
{
|
||||
spi_master_rw(buf, NULL, len);
|
||||
}
|
||||
|
||||
void mmhal_wlan_send_training_seq(void)
|
||||
{
|
||||
mmhal_wlan_spi_cs_deassert();
|
||||
/* Send >74 clock pulses to card to stabilize CLK.
|
||||
* This method of stacking up the TX data is described in RM0090 rev 19 Figure 253.
|
||||
* It results is a reduction in the time between bytes of ~85% (316ns -> 48ns).
|
||||
* Could not get this to work for the other transactions however.
|
||||
*/
|
||||
uint8_t buf[BYTE_TRAIN] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
|
||||
spi_master_rw(buf, NULL, BYTE_TRAIN);
|
||||
}
|
||||
|
||||
void mmhal_wlan_register_spi_irq_handler(mmhal_irq_handler_t handler)
|
||||
{
|
||||
spi_irq_handler = handler;
|
||||
gpio_isr_handler_add(CONFIG_MM_SPI_IRQ, (gpio_isr_t)spi_irq_handler, NULL);
|
||||
}
|
||||
|
||||
bool mmhal_wlan_spi_irq_is_asserted(void)
|
||||
{
|
||||
return !gpio_get_level(CONFIG_MM_SPI_IRQ);
|
||||
}
|
||||
|
||||
void mmhal_wlan_set_spi_irq_enabled(bool enabled)
|
||||
{
|
||||
if (enabled) {
|
||||
gpio_set_intr_type(CONFIG_MM_SPI_IRQ, GPIO_INTR_LOW_LEVEL);
|
||||
} else {
|
||||
gpio_set_intr_type(CONFIG_MM_SPI_IRQ, GPIO_INTR_DISABLE);
|
||||
}
|
||||
}
|
||||
|
||||
void mmhal_wlan_init(void)
|
||||
{
|
||||
wlan_hal_gpio_init();
|
||||
wlan_hal_spi_init();
|
||||
/* Raise the RESET_N line to enable the WLAN transceiver. */
|
||||
gpio_set_level(CONFIG_MM_RESET_N, 1);
|
||||
}
|
||||
|
||||
void mmhal_wlan_deinit(void)
|
||||
{
|
||||
/* Lower the RESET_N line to disable the WLAN transceiver. This will put the transceiver in its
|
||||
* lowest power state. */
|
||||
gpio_set_level(CONFIG_MM_RESET_N, 0);
|
||||
|
||||
wlan_hal_spi_deinit();
|
||||
|
||||
/* Clean up any ISR handlers that have been added. These will be added again if the WLAN
|
||||
* interface is brought back up. */
|
||||
gpio_isr_handler_remove(CONFIG_MM_SPI_IRQ);
|
||||
gpio_isr_handler_remove(CONFIG_MM_BUSY);
|
||||
}
|
||||
|
||||
void mmhal_wlan_wake_assert(void)
|
||||
{
|
||||
gpio_set_level(CONFIG_MM_WAKE, 1);
|
||||
}
|
||||
|
||||
void mmhal_wlan_wake_deassert(void)
|
||||
{
|
||||
gpio_set_level(CONFIG_MM_WAKE, 0);
|
||||
}
|
||||
|
||||
bool mmhal_wlan_busy_is_asserted(void)
|
||||
{
|
||||
return gpio_get_level(CONFIG_MM_BUSY);
|
||||
}
|
||||
|
||||
void mmhal_wlan_register_busy_irq_handler(mmhal_irq_handler_t handler)
|
||||
{
|
||||
busy_irq_handler = handler;
|
||||
gpio_isr_handler_add(CONFIG_MM_BUSY, (gpio_isr_t)busy_irq_handler, NULL);
|
||||
}
|
||||
|
||||
void mmhal_wlan_set_busy_irq_enabled(bool enabled)
|
||||
{
|
||||
if (enabled) {
|
||||
gpio_set_intr_type(CONFIG_MM_BUSY, GPIO_INTR_POSEDGE);
|
||||
} else {
|
||||
gpio_set_intr_type(CONFIG_MM_BUSY, GPIO_INTR_DISABLE);
|
||||
}
|
||||
}
|
||||
|
||||
#endif /* USE_MM_IOT_ESP32 */
|
||||
@@ -0,0 +1,382 @@
|
||||
"""Fake NodeDB fixture push — Portduino file copy + hardware XModem upload.
|
||||
|
||||
The fixture pipeline is two-stage:
|
||||
1. `bin/gen-fake-nodedb-seed.py` produces a deterministic JSONL describing N
|
||||
fake-but-realistic peers. Committed under `test/fixtures/nodedb/`.
|
||||
2. `bin/seed-json-to-proto.py` compiles JSONL → binary v25 NodeDatabase
|
||||
protobuf with fresh wall-clock timestamps.
|
||||
|
||||
This module exposes `push_fake_nodedb(...)`, the MCP tool that:
|
||||
- target="portduino": compiles the JSONL into the device's prefs dir on
|
||||
the local filesystem (`~/.portduino/<config>/prefs/nodes.proto`).
|
||||
- target="hardware": compiles to a temp file, then streams it over the
|
||||
XModem protocol (via the meshtastic SerialInterface/BLEInterface +
|
||||
`meshtastic.xmodempacket` pubsub topic) to `/prefs/nodes.proto` on the
|
||||
device. Triggers a reboot so the firmware loads the new state on next
|
||||
boot.
|
||||
|
||||
XModem wire details (mirrors firmware impl at src/xmodem.cpp:115-260):
|
||||
* 128-byte chunks; final chunk padded to 128 B with 0x1A (SUB) bytes.
|
||||
* CRC16-CCITT (poly 0x1021, init 0x0000).
|
||||
* SOH/seq=0 carries the destination filename in `buffer.bytes`. ACK if
|
||||
`FSCom.open(filename, FILE_O_WRITE)` succeeds; NAK otherwise.
|
||||
* SOH/seq≥1 carries a 128-byte chunk. ACK = advance; NAK = retransmit.
|
||||
* EOT after the last chunk flushes + closes the file on-device.
|
||||
|
||||
Hardware push requires `confirm=True` (mirrors factory_reset / erase_and_flash
|
||||
in the .github/copilot-instructions.md "never do these without asking" list).
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import dataclasses
|
||||
import hashlib
|
||||
import pathlib
|
||||
import queue
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import tempfile
|
||||
import time
|
||||
from typing import Any, Literal
|
||||
|
||||
from .connection import connect, is_tcp_port
|
||||
|
||||
# Resolve repo root so the tool works regardless of mcp-server cwd.
|
||||
_REPO_ROOT = pathlib.Path(__file__).resolve().parents[3]
|
||||
_SEED_DIR = _REPO_ROOT / "test" / "fixtures" / "nodedb"
|
||||
_COMPILE_SCRIPT = _REPO_ROOT / "bin" / "seed-json-to-proto.py"
|
||||
|
||||
_DEFAULT_NODES_FILENAME = "/prefs/nodes.proto"
|
||||
_XMODEM_CHUNK = 128
|
||||
_XMODEM_SUB = 0x1A
|
||||
_ACK_TIMEOUT_INIT_S = 5.0
|
||||
_ACK_TIMEOUT_CHUNK_S = 2.0
|
||||
_MAX_CHUNK_RETRIES = 5
|
||||
|
||||
_VALID_SIZES = (250, 500, 1000, 2000)
|
||||
|
||||
|
||||
class FixtureError(RuntimeError):
|
||||
"""Raised for any fixture-push failure (compile, transport, ack timeout, …)."""
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# CRC16-CCITT (poly 0x1021, init 0x0000). Matches the firmware's `crc16_ccitt`.
|
||||
# Hand-rolled to avoid the optional `crcmod` dep.
|
||||
# ---------------------------------------------------------------------------
|
||||
def _crc16_ccitt(data: bytes, *, init: int = 0x0000) -> int:
|
||||
crc = init
|
||||
for b in data:
|
||||
crc ^= b << 8
|
||||
for _ in range(8):
|
||||
if crc & 0x8000:
|
||||
crc = ((crc << 1) ^ 0x1021) & 0xFFFF
|
||||
else:
|
||||
crc = (crc << 1) & 0xFFFF
|
||||
return crc
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Compile step — shells out to bin/seed-json-to-proto.py so the MCP module
|
||||
# doesn't have to duplicate the proto-encoding logic.
|
||||
# ---------------------------------------------------------------------------
|
||||
def _compile_proto(jsonl_path: pathlib.Path, out_path: pathlib.Path) -> None:
|
||||
if not _COMPILE_SCRIPT.is_file():
|
||||
raise FixtureError(f"compile script missing at {_COMPILE_SCRIPT}")
|
||||
cmd = [
|
||||
sys.executable,
|
||||
str(_COMPILE_SCRIPT),
|
||||
"--in",
|
||||
str(jsonl_path),
|
||||
"--out",
|
||||
str(out_path),
|
||||
]
|
||||
try:
|
||||
subprocess.run(cmd, check=True, capture_output=True, text=True)
|
||||
except subprocess.CalledProcessError as exc:
|
||||
raise FixtureError(
|
||||
f"seed-json-to-proto.py failed (exit {exc.returncode}):\n"
|
||||
f" stdout: {exc.stdout}\n stderr: {exc.stderr}"
|
||||
) from exc
|
||||
|
||||
|
||||
def _resolve_seed_jsonl(size: int, custom: str | None) -> pathlib.Path:
|
||||
if custom is not None:
|
||||
p = pathlib.Path(custom).expanduser().resolve()
|
||||
if not p.is_file():
|
||||
raise FixtureError(f"custom_seed_jsonl not found: {p}")
|
||||
return p
|
||||
p = _SEED_DIR / f"seed_v25_{size:04d}.jsonl"
|
||||
if not p.is_file():
|
||||
raise FixtureError(
|
||||
f"missing committed seed at {p}. "
|
||||
f"Run `./bin/regen-fake-nodedbs.sh` to generate it."
|
||||
)
|
||||
return p
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Portduino push — file copy into ~/.portduino/<config>/prefs/
|
||||
# ---------------------------------------------------------------------------
|
||||
def _portduino_prefs_dir(config_name: str) -> pathlib.Path:
|
||||
home = pathlib.Path.home()
|
||||
return home / ".portduino" / config_name / "prefs"
|
||||
|
||||
|
||||
def _push_portduino(
|
||||
size: int,
|
||||
jsonl: pathlib.Path,
|
||||
portduino_config: str,
|
||||
backup_existing: bool,
|
||||
) -> dict[str, Any]:
|
||||
prefs = _portduino_prefs_dir(portduino_config)
|
||||
prefs.mkdir(parents=True, exist_ok=True)
|
||||
target = prefs / "nodes.proto"
|
||||
backed_up_to: str | None = None
|
||||
if backup_existing and target.is_file():
|
||||
ts = int(time.time())
|
||||
backup = prefs / f"nodes.proto.bak.{ts}"
|
||||
shutil.move(str(target), str(backup))
|
||||
backed_up_to = str(backup)
|
||||
_compile_proto(jsonl, target)
|
||||
raw = target.read_bytes()
|
||||
return {
|
||||
"transport": "portduino",
|
||||
"path": str(target),
|
||||
"bytes": len(raw),
|
||||
"sha256": hashlib.sha256(raw).hexdigest(),
|
||||
"jsonl_source": str(jsonl),
|
||||
"backed_up_to": backed_up_to,
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Hardware push — XModem over BLE/serial via the meshtastic Python interface.
|
||||
# ---------------------------------------------------------------------------
|
||||
@dataclasses.dataclass
|
||||
class _AckEvent:
|
||||
control: int
|
||||
seq: int
|
||||
|
||||
|
||||
def _wait_for_response(q: "queue.Queue[_AckEvent]", timeout_s: float) -> _AckEvent:
|
||||
try:
|
||||
return q.get(timeout=timeout_s)
|
||||
except queue.Empty as exc:
|
||||
raise FixtureError(
|
||||
f"XModem response timeout after {timeout_s:.1f}s — device not responding"
|
||||
) from exc
|
||||
|
||||
|
||||
def _push_hardware(
|
||||
size: int,
|
||||
jsonl: pathlib.Path,
|
||||
port: str | None,
|
||||
reboot_after: bool,
|
||||
) -> dict[str, Any]:
|
||||
# Lazy imports so the module loads even when the meshtastic deps aren't
|
||||
# available (e.g. CI in a Python env without the package installed).
|
||||
try:
|
||||
from meshtastic.protobuf import mesh_pb2, xmodem_pb2
|
||||
from pubsub import pub
|
||||
except ImportError as exc: # pragma: no cover — dep missing
|
||||
raise FixtureError(
|
||||
f"hardware push requires the meshtastic + pypubsub packages: {exc}"
|
||||
) from exc
|
||||
|
||||
if is_tcp_port(port):
|
||||
raise FixtureError(
|
||||
"hardware push over TCP/portduino is not supported — use "
|
||||
"target='portduino' to drop the fixture directly into the prefs dir."
|
||||
)
|
||||
|
||||
# Compile the fixture to a temp file with fresh timestamps.
|
||||
with tempfile.NamedTemporaryFile(suffix=".proto", delete=False) as tf:
|
||||
proto_path = pathlib.Path(tf.name)
|
||||
try:
|
||||
_compile_proto(jsonl, proto_path)
|
||||
payload = proto_path.read_bytes()
|
||||
finally:
|
||||
proto_path.unlink(missing_ok=True)
|
||||
|
||||
sha256 = hashlib.sha256(payload).hexdigest()
|
||||
total_bytes = len(payload)
|
||||
|
||||
# Subscribe to XModem responses BEFORE we open the interface, so we don't
|
||||
# race the first ACK that arrives during the SOH/seq=0 handshake.
|
||||
#
|
||||
# NB: the signature MUST declare every kwarg pypubsub will see for this
|
||||
# topic, or pubsub locks the topic spec to a smaller set (whichever
|
||||
# subscribe arrives first) and then *rejects* the meshtastic library's
|
||||
# publish call with `SenderUnknownMsgDataError: unknown ... interface`.
|
||||
# The meshtastic lib publishes both `packet=` and `interface=`
|
||||
# (mesh_interface.py:1389-1395), so both must appear here.
|
||||
response_q: "queue.Queue[_AckEvent]" = queue.Queue()
|
||||
|
||||
def _on_xmodem(packet: Any = None, interface: Any = None, **_kw: Any) -> None:
|
||||
if packet is None:
|
||||
return
|
||||
response_q.put(_AckEvent(control=int(packet.control), seq=int(packet.seq)))
|
||||
|
||||
pub.subscribe(_on_xmodem, "meshtastic.xmodempacket")
|
||||
|
||||
chunks_sent = 0
|
||||
retried = 0
|
||||
rebooted = False
|
||||
|
||||
XMC = xmodem_pb2.XModem.Control
|
||||
try:
|
||||
with connect(port=port) as iface:
|
||||
# 1) Send the filename (SOH, seq=0).
|
||||
init_pkt = xmodem_pb2.XModem(
|
||||
control=XMC.Value("SOH"),
|
||||
seq=0,
|
||||
buffer=_DEFAULT_NODES_FILENAME.encode("utf-8"),
|
||||
)
|
||||
iface._sendToRadio(mesh_pb2.ToRadio(xmodemPacket=init_pkt))
|
||||
ack = _wait_for_response(response_q, _ACK_TIMEOUT_INIT_S)
|
||||
if ack.control != XMC.Value("ACK"):
|
||||
raise FixtureError(
|
||||
f"device refused filename {_DEFAULT_NODES_FILENAME!r} "
|
||||
f"(got control={ack.control}, expected ACK). "
|
||||
f"Filesystem full or permissions issue?"
|
||||
)
|
||||
|
||||
# 2) Stream the payload in 128 B chunks.
|
||||
for offset in range(0, total_bytes, _XMODEM_CHUNK):
|
||||
chunk = payload[offset : offset + _XMODEM_CHUNK]
|
||||
if len(chunk) < _XMODEM_CHUNK:
|
||||
# Pad final chunk to 128 B with SUB. The trailing 0x1A bytes
|
||||
# become part of the file on-device, but nanopb ignores
|
||||
# bytes past the end of the top-level message.
|
||||
chunk = chunk + bytes([_XMODEM_SUB] * (_XMODEM_CHUNK - len(chunk)))
|
||||
seq = ((offset // _XMODEM_CHUNK) + 1) % 256
|
||||
# Retry loop on NAK / timeout.
|
||||
attempts = 0
|
||||
while True:
|
||||
pkt = xmodem_pb2.XModem(
|
||||
control=XMC.Value("SOH"),
|
||||
seq=seq,
|
||||
buffer=chunk,
|
||||
crc16=_crc16_ccitt(chunk),
|
||||
)
|
||||
iface._sendToRadio(mesh_pb2.ToRadio(xmodemPacket=pkt))
|
||||
ack = _wait_for_response(response_q, _ACK_TIMEOUT_CHUNK_S)
|
||||
if ack.control == XMC.Value("ACK"):
|
||||
chunks_sent += 1
|
||||
break
|
||||
if ack.control == XMC.Value("NAK"):
|
||||
attempts += 1
|
||||
retried += 1
|
||||
if attempts >= _MAX_CHUNK_RETRIES:
|
||||
# Abort: send CAN so the firmware removes the half-
|
||||
# written file via FSCom.remove(filename).
|
||||
iface._sendToRadio(
|
||||
mesh_pb2.ToRadio(
|
||||
xmodemPacket=xmodem_pb2.XModem(
|
||||
control=XMC.Value("CAN")
|
||||
)
|
||||
)
|
||||
)
|
||||
raise FixtureError(
|
||||
f"chunk seq={seq} NAK'd {attempts} times; "
|
||||
f"aborted transfer (file removed on-device)."
|
||||
)
|
||||
continue # retry the same chunk
|
||||
raise FixtureError(
|
||||
f"unexpected XModem control={ack.control} on seq={seq}"
|
||||
)
|
||||
|
||||
# 3) Tell the device we're done.
|
||||
iface._sendToRadio(
|
||||
mesh_pb2.ToRadio(
|
||||
xmodemPacket=xmodem_pb2.XModem(control=XMC.Value("EOT"))
|
||||
)
|
||||
)
|
||||
ack = _wait_for_response(response_q, _ACK_TIMEOUT_CHUNK_S)
|
||||
if ack.control != XMC.Value("ACK"):
|
||||
raise FixtureError(f"EOT not ACKed (got control={ack.control})")
|
||||
|
||||
# 4) Reboot so loadFromDisk picks up the new file.
|
||||
if reboot_after:
|
||||
iface.localNode.reboot(secs=1)
|
||||
rebooted = True
|
||||
finally:
|
||||
try:
|
||||
pub.unsubscribe(_on_xmodem, "meshtastic.xmodempacket")
|
||||
except Exception:
|
||||
pass
|
||||
|
||||
return {
|
||||
"transport": "hardware",
|
||||
"port": port,
|
||||
"filename_on_device": _DEFAULT_NODES_FILENAME,
|
||||
"bytes": total_bytes,
|
||||
"chunks_sent": chunks_sent,
|
||||
"retried": retried,
|
||||
"sha256": sha256,
|
||||
"jsonl_source": str(jsonl),
|
||||
"rebooted": rebooted,
|
||||
}
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Public entry point — registered as an MCP tool in server.py.
|
||||
# ---------------------------------------------------------------------------
|
||||
def push_fake_nodedb(
|
||||
size: int,
|
||||
target: Literal["portduino", "hardware"] = "portduino",
|
||||
*,
|
||||
port: str | None = None,
|
||||
portduino_config: str = "default",
|
||||
backup_existing: bool = True,
|
||||
confirm: bool = False,
|
||||
reboot_after: bool = True,
|
||||
custom_seed_jsonl: str | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""Compile a fresh-timestamp NodeDatabase fixture and push it to a device.
|
||||
|
||||
Args:
|
||||
size: 250, 500, 1000, or 2000 — selects which committed seed JSONL to use.
|
||||
target: "portduino" (file copy to ~/.portduino/<config>/prefs/) or
|
||||
"hardware" (XModem upload to /prefs/nodes.proto + reboot).
|
||||
port: required for target="hardware". Serial path (e.g. /dev/cu.usbmodemXXXX)
|
||||
or BLE identifier. TCP endpoints are rejected — use target="portduino"
|
||||
instead.
|
||||
portduino_config: which Portduino instance dir under ~/.portduino/. Default "default".
|
||||
backup_existing: portduino only. Move nodes.proto -> nodes.proto.bak.<ts>
|
||||
if present, so you can roll back.
|
||||
confirm: required True for target="hardware" (writes flash + reboots).
|
||||
reboot_after: hardware only. If True, send a 1-second reboot after the
|
||||
final ACK so loadFromDisk picks up the new file at next boot.
|
||||
custom_seed_jsonl: override the committed JSONL. Use to push a hand-edited
|
||||
test scenario.
|
||||
|
||||
Returns:
|
||||
dict with transport, bytes, sha256, etc. — depends on target.
|
||||
|
||||
"""
|
||||
if size not in _VALID_SIZES:
|
||||
raise FixtureError(
|
||||
f"size must be one of {_VALID_SIZES}; got {size!r}. "
|
||||
f"Add a new committed seed if you need a different cardinality."
|
||||
)
|
||||
|
||||
jsonl = _resolve_seed_jsonl(size, custom_seed_jsonl)
|
||||
|
||||
if target == "portduino":
|
||||
return _push_portduino(size, jsonl, portduino_config, backup_existing)
|
||||
|
||||
if target == "hardware":
|
||||
if not confirm:
|
||||
raise FixtureError(
|
||||
"hardware push writes flash and triggers a reboot — pass confirm=True."
|
||||
)
|
||||
if not port:
|
||||
raise FixtureError(
|
||||
"target='hardware' requires a port (e.g. /dev/cu.usbmodemXXXX)."
|
||||
)
|
||||
return _push_hardware(size, jsonl, port, reboot_after)
|
||||
|
||||
raise FixtureError(f"unknown target {target!r}; expected 'portduino' or 'hardware'")
|
||||
@@ -15,6 +15,7 @@ from . import (
|
||||
admin,
|
||||
boards,
|
||||
devices,
|
||||
fixtures,
|
||||
flash,
|
||||
hw_tools,
|
||||
info,
|
||||
@@ -963,3 +964,45 @@ def recorder_export(
|
||||
dest_dir=dest_dir,
|
||||
streams=streams,
|
||||
)
|
||||
|
||||
|
||||
# ---------- Fixture / test-data push --------------------------------------
|
||||
|
||||
|
||||
@app.tool()
|
||||
def push_fake_nodedb(
|
||||
size: int,
|
||||
target: str = "portduino",
|
||||
port: str | None = None,
|
||||
portduino_config: str = "default",
|
||||
backup_existing: bool = True,
|
||||
confirm: bool = False,
|
||||
reboot_after: bool = True,
|
||||
custom_seed_jsonl: str | None = None,
|
||||
) -> dict[str, Any]:
|
||||
"""Push a fake-NodeDB v25 fixture (250/500/1000/2000 nodes) onto a device.
|
||||
|
||||
Two transports:
|
||||
target="portduino" — file copy to ~/.portduino/<portduino_config>/prefs/nodes.proto.
|
||||
Fast, no device connection needed.
|
||||
target="hardware" — XModem upload over serial/BLE to /prefs/nodes.proto.
|
||||
Requires `port` + `confirm=True`. Triggers a reboot
|
||||
so loadFromDisk picks up the new file at next boot.
|
||||
|
||||
Compiles a fresh-timestamp proto from the committed JSONL seed under
|
||||
test/fixtures/nodedb/seed_v25_<N>.jsonl each invocation, so the loaded
|
||||
NodeDB always looks "recent" to the connecting phone. Structural data
|
||||
(names, IDs, positions, telemetries) is deterministic per the seed.
|
||||
|
||||
Override the JSONL via `custom_seed_jsonl` to push a hand-edited scenario.
|
||||
"""
|
||||
return fixtures.push_fake_nodedb(
|
||||
size=size,
|
||||
target=target, # type: ignore[arg-type]
|
||||
port=port,
|
||||
portduino_config=portduino_config,
|
||||
backup_existing=backup_existing,
|
||||
confirm=confirm,
|
||||
reboot_after=reboot_after,
|
||||
custom_seed_jsonl=custom_seed_jsonl,
|
||||
)
|
||||
|
||||
@@ -0,0 +1,364 @@
|
||||
"""Tests for the fake-NodeDB fixture pipeline (bin/gen-fake-nodedb-seed.py
|
||||
+ bin/seed-json-to-proto.py + mcp-server fixtures.push_fake_nodedb).
|
||||
|
||||
Lives under tests/unit/ because none of these touch real hardware — they
|
||||
shell out to the bin/ scripts and decode the resulting protobufs in-process.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import pathlib
|
||||
import subprocess
|
||||
import sys
|
||||
import time
|
||||
|
||||
import pytest
|
||||
|
||||
REPO_ROOT = pathlib.Path(__file__).resolve().parents[3]
|
||||
SEED_GEN = REPO_ROOT / "bin" / "gen-fake-nodedb-seed.py"
|
||||
COMPILE = REPO_ROOT / "bin" / "seed-json-to-proto.py"
|
||||
FIXTURES_DIR = REPO_ROOT / "test" / "fixtures" / "nodedb"
|
||||
|
||||
# Ensure the locally-generated Python protobuf bindings are importable.
|
||||
# These live under `meshtastic_v25` (not `meshtastic`) so they don't shadow
|
||||
# the PyPI `meshtastic` package that the rest of the mcp-server depends on.
|
||||
_BINDINGS_DIR = REPO_ROOT / "bin" / "_generated"
|
||||
if _BINDINGS_DIR.is_dir() and str(_BINDINGS_DIR) not in sys.path:
|
||||
sys.path.insert(0, str(_BINDINGS_DIR))
|
||||
|
||||
try:
|
||||
from meshtastic_v25.deviceonly_pb2 import (
|
||||
NodeDatabase, # type: ignore[import-not-found]
|
||||
)
|
||||
except ImportError:
|
||||
NodeDatabase = None # type: ignore[assignment]
|
||||
|
||||
|
||||
def _require_v25_bindings() -> None:
|
||||
if NodeDatabase is None:
|
||||
pytest.skip(
|
||||
"v25 Python protobuf bindings missing; run `./bin/regen-py-protos.sh`."
|
||||
)
|
||||
if "positions" not in NodeDatabase.DESCRIPTOR.fields_by_name:
|
||||
pytest.skip(
|
||||
"Loaded NodeDatabase predates v25 — run `./bin/regen-py-protos.sh`."
|
||||
)
|
||||
|
||||
|
||||
def _run(cmd: list[str]) -> None:
|
||||
subprocess.check_call(cmd, stdout=subprocess.DEVNULL, stderr=subprocess.PIPE)
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Seed generator: deterministic for given --seed (no wall-clock dependence).
|
||||
# ---------------------------------------------------------------------------
|
||||
def test_seed_generator_is_deterministic(tmp_path: pathlib.Path) -> None:
|
||||
a = tmp_path / "a.jsonl"
|
||||
b = tmp_path / "b.jsonl"
|
||||
_run(
|
||||
[
|
||||
sys.executable,
|
||||
str(SEED_GEN),
|
||||
"--count",
|
||||
"100",
|
||||
"--seed",
|
||||
"42",
|
||||
"--out",
|
||||
str(a),
|
||||
]
|
||||
)
|
||||
# Sleep so any sneaky wall-clock leak in the generator would surface as
|
||||
# a byte diff between the two runs.
|
||||
time.sleep(0.8)
|
||||
_run(
|
||||
[
|
||||
sys.executable,
|
||||
str(SEED_GEN),
|
||||
"--count",
|
||||
"100",
|
||||
"--seed",
|
||||
"42",
|
||||
"--out",
|
||||
str(b),
|
||||
]
|
||||
)
|
||||
assert a.read_bytes() == b.read_bytes()
|
||||
|
||||
|
||||
def test_seed_generator_meta_line(tmp_path: pathlib.Path) -> None:
|
||||
out = tmp_path / "seed.jsonl"
|
||||
_run(
|
||||
[
|
||||
sys.executable,
|
||||
str(SEED_GEN),
|
||||
"--count",
|
||||
"50",
|
||||
"--seed",
|
||||
"1",
|
||||
"--out",
|
||||
str(out),
|
||||
]
|
||||
)
|
||||
lines = out.read_text(encoding="utf-8").splitlines()
|
||||
assert len(lines) == 51 # 1 meta + 50 nodes
|
||||
meta = json.loads(lines[0])
|
||||
assert "_meta" in meta
|
||||
assert meta["_meta"]["version"] == 25
|
||||
assert meta["_meta"]["count"] == 50
|
||||
assert meta["_meta"]["seed"] == 1
|
||||
|
||||
|
||||
def test_seed_only_uses_active_hardware_and_roles(tmp_path: pathlib.Path) -> None:
|
||||
"""Confirm no deprecated roles + no off-list HW models leak through."""
|
||||
out = tmp_path / "seed.jsonl"
|
||||
_run(
|
||||
[
|
||||
sys.executable,
|
||||
str(SEED_GEN),
|
||||
"--count",
|
||||
"500",
|
||||
"--seed",
|
||||
"7",
|
||||
"--out",
|
||||
str(out),
|
||||
]
|
||||
)
|
||||
forbidden_roles = {"ROUTER_CLIENT", "REPEATER"}
|
||||
forbidden_hw = {
|
||||
"TLORA_V1",
|
||||
"TLORA_V2",
|
||||
"TLORA_V1_1P3",
|
||||
"TLORA_V2_1_1P6",
|
||||
"TLORA_V2_1_1P8",
|
||||
"HELTEC_V1",
|
||||
"HELTEC_V2_0",
|
||||
"HELTEC_V2_1",
|
||||
"TBEAM",
|
||||
"TBEAM_V0P7",
|
||||
"NANO_G1",
|
||||
"NANO_G1_EXPLORER",
|
||||
"NANO_G2_ULTRA",
|
||||
"STATION_G1",
|
||||
"STATION_G2",
|
||||
"PORTDUINO",
|
||||
"ANDROID_SIM",
|
||||
"DIY_V1",
|
||||
"LORA_RELAY_V1",
|
||||
"NRF52840_PCA10059",
|
||||
"NRF52_UNKNOWN",
|
||||
"DR_DEV",
|
||||
"GENIEBLOCKS",
|
||||
"M5STACK",
|
||||
"RP2040_LORA",
|
||||
"PPR",
|
||||
}
|
||||
for raw in out.read_text(encoding="utf-8").splitlines()[1:]:
|
||||
node = json.loads(raw)
|
||||
assert node["role"] not in forbidden_roles, f"deprecated role: {node['role']}"
|
||||
assert (
|
||||
node["hw_model"] not in forbidden_hw
|
||||
), f"non-tier-1 HW: {node['hw_model']}"
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Compile step + committed seeds.
|
||||
# ---------------------------------------------------------------------------
|
||||
@pytest.mark.parametrize("size", [250, 500, 1000, 2000])
|
||||
def test_committed_seed_compiles_and_decodes(size: int, tmp_path: pathlib.Path) -> None:
|
||||
_require_v25_bindings()
|
||||
proto = tmp_path / "out.proto"
|
||||
jsonl = FIXTURES_DIR / f"seed_v25_{size:04d}.jsonl"
|
||||
if not jsonl.is_file():
|
||||
pytest.skip(f"{jsonl} not present — run ./bin/regen-fake-nodedbs.sh")
|
||||
_run([sys.executable, str(COMPILE), "--in", str(jsonl), "--out", str(proto)])
|
||||
|
||||
db = NodeDatabase()
|
||||
db.ParseFromString(proto.read_bytes())
|
||||
assert db.version == 25
|
||||
assert len(db.nodes) == size
|
||||
nums = {n.num for n in db.nodes}
|
||||
assert len(nums) == size, "node numbers must be unique"
|
||||
assert all(n.long_name and n.short_name for n in db.nodes)
|
||||
assert all(len(n.long_name) <= 24 for n in db.nodes) # max_size:25 - NUL
|
||||
|
||||
# Coverage sanity (±10pp tolerance for binomial fluctuation).
|
||||
def in_range(actual: int, expected_ratio: float, tol_pp: float = 0.10) -> bool:
|
||||
lo = max(0, int((expected_ratio - tol_pp) * size))
|
||||
hi = min(size, int((expected_ratio + tol_pp) * size))
|
||||
return lo <= actual <= hi
|
||||
|
||||
assert in_range(len(db.positions), 0.85)
|
||||
assert in_range(len(db.telemetry), 0.70)
|
||||
assert in_range(len(db.environment), 0.25)
|
||||
assert in_range(len(db.status), 0.40)
|
||||
|
||||
|
||||
def test_compile_freshens_timestamps(tmp_path: pathlib.Path) -> None:
|
||||
"""Same JSONL compiled twice → identical structure, different timestamps."""
|
||||
_require_v25_bindings()
|
||||
jsonl = FIXTURES_DIR / "seed_v25_0250.jsonl"
|
||||
if not jsonl.is_file():
|
||||
pytest.skip("250-node seed not present — run ./bin/regen-fake-nodedbs.sh")
|
||||
a = tmp_path / "a.proto"
|
||||
b = tmp_path / "b.proto"
|
||||
_run([sys.executable, str(COMPILE), "--in", str(jsonl), "--out", str(a)])
|
||||
time.sleep(1.2)
|
||||
_run([sys.executable, str(COMPILE), "--in", str(jsonl), "--out", str(b)])
|
||||
|
||||
da = NodeDatabase()
|
||||
db_ = NodeDatabase()
|
||||
da.ParseFromString(a.read_bytes())
|
||||
db_.ParseFromString(b.read_bytes())
|
||||
|
||||
# Zero out timestamp fields and confirm everything else is byte-identical.
|
||||
for d in (da, db_):
|
||||
for n in d.nodes:
|
||||
n.last_heard = 0
|
||||
for p in d.positions:
|
||||
p.position.time = 0
|
||||
assert da.SerializeToString() == db_.SerializeToString()
|
||||
|
||||
# Re-load fresh copies to confirm timestamps actually moved.
|
||||
aa = NodeDatabase()
|
||||
bb = NodeDatabase()
|
||||
aa.ParseFromString(a.read_bytes())
|
||||
bb.ParseFromString(b.read_bytes())
|
||||
aa_max = max(n.last_heard for n in aa.nodes if n.last_heard)
|
||||
bb_max = max(n.last_heard for n in bb.nodes if n.last_heard)
|
||||
assert bb_max >= aa_max
|
||||
assert bb_max - aa_max < 5 # within a few seconds
|
||||
|
||||
|
||||
def test_compile_pinned_now_epoch_is_byte_identical(tmp_path: pathlib.Path) -> None:
|
||||
"""With --now-epoch pinned, two compiles produce identical bytes."""
|
||||
_require_v25_bindings()
|
||||
jsonl = FIXTURES_DIR / "seed_v25_0250.jsonl"
|
||||
if not jsonl.is_file():
|
||||
pytest.skip("250-node seed not present")
|
||||
a = tmp_path / "a.proto"
|
||||
b = tmp_path / "b.proto"
|
||||
for o in (a, b):
|
||||
_run(
|
||||
[
|
||||
sys.executable,
|
||||
str(COMPILE),
|
||||
"--in",
|
||||
str(jsonl),
|
||||
"--now-epoch",
|
||||
"1700000000",
|
||||
"--out",
|
||||
str(o),
|
||||
]
|
||||
)
|
||||
assert a.read_bytes() == b.read_bytes()
|
||||
|
||||
|
||||
def test_compile_timestamps_are_recent(tmp_path: pathlib.Path) -> None:
|
||||
_require_v25_bindings()
|
||||
jsonl = FIXTURES_DIR / "seed_v25_0250.jsonl"
|
||||
if not jsonl.is_file():
|
||||
pytest.skip("250-node seed not present")
|
||||
out = tmp_path / "out.proto"
|
||||
_run([sys.executable, str(COMPILE), "--in", str(jsonl), "--out", str(out)])
|
||||
db = NodeDatabase()
|
||||
db.ParseFromString(out.read_bytes())
|
||||
now = int(time.time())
|
||||
# No timestamp older than 7 days, none in the future.
|
||||
for n in db.nodes:
|
||||
if n.last_heard:
|
||||
assert now - 7 * 86400 <= n.last_heard <= now
|
||||
# At least half should be within the last hour
|
||||
# (matches expovariate(mean=3600s)).
|
||||
recent = sum(1 for n in db.nodes if n.last_heard and n.last_heard >= now - 3600)
|
||||
assert recent >= 0.4 * len(db.nodes)
|
||||
|
||||
|
||||
def test_compile_hand_edit_round_trip(tmp_path: pathlib.Path) -> None:
|
||||
"""Edit one JSONL line, recompile, confirm edit appears in the proto."""
|
||||
_require_v25_bindings()
|
||||
src = FIXTURES_DIR / "seed_v25_0250.jsonl"
|
||||
if not src.is_file():
|
||||
pytest.skip("250-node seed not present")
|
||||
dst = tmp_path / "edited.jsonl"
|
||||
lines = src.read_text(encoding="utf-8").splitlines()
|
||||
|
||||
# Find a node that already has telemetry so the index relationship is
|
||||
# easy to assert on the other side.
|
||||
edit_idx = None
|
||||
for i, raw in enumerate(lines[1:], start=1):
|
||||
node = json.loads(raw)
|
||||
if node.get("telemetry") is not None:
|
||||
edit_idx = i
|
||||
break
|
||||
assert edit_idx is not None, "expected at least one node with telemetry"
|
||||
|
||||
node = json.loads(lines[edit_idx])
|
||||
target_num = int(node["num"], 16)
|
||||
node["long_name"] = "Hand Edited Node"
|
||||
node["telemetry"] = {
|
||||
"battery_level": 42,
|
||||
"voltage": 3.71,
|
||||
"channel_utilization": 0.0,
|
||||
"air_util_tx": 0.0,
|
||||
"uptime_seconds": 1,
|
||||
}
|
||||
lines[edit_idx] = json.dumps(node, ensure_ascii=False, sort_keys=True)
|
||||
dst.write_text("\n".join(lines) + "\n", encoding="utf-8")
|
||||
|
||||
out = tmp_path / "out.proto"
|
||||
_run([sys.executable, str(COMPILE), "--in", str(dst), "--out", str(out)])
|
||||
db = NodeDatabase()
|
||||
db.ParseFromString(out.read_bytes())
|
||||
edited = next((n for n in db.nodes if n.num == target_num), None)
|
||||
assert edited is not None
|
||||
assert edited.long_name == "Hand Edited Node"
|
||||
tel = next((t for t in db.telemetry if t.num == target_num), None)
|
||||
assert tel is not None
|
||||
assert tel.device_metrics.battery_level == 42
|
||||
|
||||
|
||||
# ---------------------------------------------------------------------------
|
||||
# Misc smoke checks on the module surface.
|
||||
# ---------------------------------------------------------------------------
|
||||
def test_crc16_ccitt_matches_known_vectors() -> None:
|
||||
"""Sanity-check the hand-rolled CRC16-CCITT matches well-known vectors.
|
||||
|
||||
Test vectors from the XModem-CRC spec (init=0, poly=0x1021):
|
||||
crc16("123456789") = 0x31C3
|
||||
crc16("") = 0x0000
|
||||
"""
|
||||
from meshtastic_mcp.fixtures import _crc16_ccitt
|
||||
|
||||
assert _crc16_ccitt(b"") == 0x0000
|
||||
assert _crc16_ccitt(b"123456789") == 0x31C3
|
||||
|
||||
|
||||
def test_push_fake_nodedb_rejects_invalid_size() -> None:
|
||||
from meshtastic_mcp.fixtures import FixtureError, push_fake_nodedb
|
||||
|
||||
with pytest.raises(FixtureError, match="size must be one of"):
|
||||
push_fake_nodedb(size=999, target="portduino") # type: ignore[arg-type]
|
||||
|
||||
|
||||
def test_push_fake_nodedb_hardware_requires_confirm() -> None:
|
||||
from meshtastic_mcp.fixtures import FixtureError, push_fake_nodedb
|
||||
|
||||
with pytest.raises(FixtureError, match="confirm=True"):
|
||||
push_fake_nodedb(size=250, target="hardware", port="/dev/cu.fake")
|
||||
|
||||
|
||||
def test_push_fake_nodedb_hardware_requires_port() -> None:
|
||||
from meshtastic_mcp.fixtures import FixtureError, push_fake_nodedb
|
||||
|
||||
with pytest.raises(FixtureError, match="requires a port"):
|
||||
push_fake_nodedb(size=250, target="hardware", confirm=True)
|
||||
|
||||
|
||||
def test_push_fake_nodedb_hardware_rejects_tcp_port() -> None:
|
||||
from meshtastic_mcp.fixtures import FixtureError, push_fake_nodedb
|
||||
|
||||
with pytest.raises(FixtureError, match="not supported"):
|
||||
push_fake_nodedb(
|
||||
size=250, target="hardware", confirm=True, port="tcp://localhost:4403"
|
||||
)
|
||||
+2
-1
@@ -49,6 +49,7 @@ build_flags = -Wno-missing-field-initializers
|
||||
-DRADIOLIB_EXCLUDE_PAGER=1
|
||||
-DRADIOLIB_EXCLUDE_FSK4=1
|
||||
-DRADIOLIB_EXCLUDE_APRS=1
|
||||
-DRADIOLIB_EXCLUDE_ADSB=1
|
||||
-DRADIOLIB_EXCLUDE_LORAWAN=1
|
||||
-DMESHTASTIC_EXCLUDE_DROPZONE=1
|
||||
-DMESHTASTIC_EXCLUDE_REPLYBOT=1
|
||||
@@ -137,7 +138,7 @@ lib_deps =
|
||||
# renovate: datasource=github-tags depName=Adafruit GFX packageName=adafruit/Adafruit-GFX-Library
|
||||
https://github.com/adafruit/Adafruit-GFX-Library/archive/refs/tags/1.12.6.zip
|
||||
# renovate: datasource=github-tags depName=NeoPixel packageName=adafruit/Adafruit_NeoPixel
|
||||
https://github.com/adafruit/Adafruit_NeoPixel/archive/refs/tags/1.15.4.zip
|
||||
https://github.com/adafruit/Adafruit_NeoPixel/archive/1.15.5.zip
|
||||
# renovate: datasource=github-tags depName=Adafruit SSD1306 packageName=adafruit/Adafruit_SSD1306
|
||||
https://github.com/adafruit/Adafruit_SSD1306/archive/refs/tags/2.5.16.zip
|
||||
# renovate: datasource=github-tags depName=Adafruit BMP280 packageName=adafruit/Adafruit_BMP280_Library
|
||||
|
||||
+1
-1
Submodule protobufs updated: 559f3c12dd...7ffb4bb60d
+26
-31
@@ -6,7 +6,6 @@
|
||||
#include "SPILock.h"
|
||||
#include "SafeFile.h"
|
||||
#include "gps/RTC.h"
|
||||
#include "graphics/draw/MessageRenderer.h"
|
||||
#include <cstring> // memcpy
|
||||
|
||||
#ifndef MESSAGE_TEXT_POOL_SIZE
|
||||
@@ -181,13 +180,8 @@ const StoredMessage &MessageStore::addFromPacket(const meshtastic_MeshPacket &pa
|
||||
|
||||
bool isDM = (sm.dest != 0 && sm.dest != NODENUM_BROADCAST);
|
||||
|
||||
if (packet.from == 0) {
|
||||
sm.type = isDM ? MessageType::DM_TO_US : MessageType::BROADCAST;
|
||||
sm.ackStatus = AckStatus::NONE;
|
||||
} else {
|
||||
sm.type = isDM ? MessageType::DM_TO_US : MessageType::BROADCAST;
|
||||
sm.ackStatus = AckStatus::ACKED;
|
||||
}
|
||||
sm.type = isDM ? MessageType::DM_TO_US : MessageType::BROADCAST;
|
||||
sm.ackStatus = (packet.from == 0) ? AckStatus::NONE : AckStatus::ACKED;
|
||||
|
||||
addLiveMessage(sm);
|
||||
|
||||
@@ -372,26 +366,25 @@ void MessageStore::clearAllMessages()
|
||||
#endif
|
||||
}
|
||||
|
||||
// Internal helper: erase first or last message matching a predicate
|
||||
template <typename Predicate> static void eraseIf(std::deque<StoredMessage> &deque, Predicate pred, bool fromBack = false)
|
||||
// Internal helpers for targeted erasure.
|
||||
template <typename Predicate> static bool eraseFirstMatch(std::deque<StoredMessage> &deque, Predicate pred)
|
||||
{
|
||||
if (fromBack) {
|
||||
// Iterate from the back and erase all matches from the end
|
||||
for (auto it = deque.rbegin(); it != deque.rend();) {
|
||||
if (pred(*it)) {
|
||||
it = std::deque<StoredMessage>::reverse_iterator(deque.erase(std::next(it).base()));
|
||||
} else {
|
||||
++it;
|
||||
}
|
||||
for (auto it = deque.begin(); it != deque.end(); ++it) {
|
||||
if (pred(*it)) {
|
||||
deque.erase(it);
|
||||
return true;
|
||||
}
|
||||
} else {
|
||||
// Manual forward search to erase all matches
|
||||
for (auto it = deque.begin(); it != deque.end();) {
|
||||
if (pred(*it)) {
|
||||
it = deque.erase(it);
|
||||
} else {
|
||||
++it;
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
template <typename Predicate> static void eraseAllMatches(std::deque<StoredMessage> &deque, Predicate pred)
|
||||
{
|
||||
for (auto it = deque.begin(); it != deque.end();) {
|
||||
if (pred(*it)) {
|
||||
it = deque.erase(it);
|
||||
} else {
|
||||
++it;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -399,7 +392,9 @@ template <typename Predicate> static void eraseIf(std::deque<StoredMessage> &deq
|
||||
// Delete oldest message (RAM + persisted queue)
|
||||
void MessageStore::deleteOldestMessage()
|
||||
{
|
||||
eraseIf(liveMessages, [](StoredMessage &) { return true; });
|
||||
if (!liveMessages.empty()) {
|
||||
liveMessages.pop_front();
|
||||
}
|
||||
saveToFlash();
|
||||
}
|
||||
|
||||
@@ -407,14 +402,14 @@ void MessageStore::deleteOldestMessage()
|
||||
void MessageStore::deleteOldestMessageInChannel(uint8_t channel)
|
||||
{
|
||||
auto pred = [channel](const StoredMessage &m) { return m.type == MessageType::BROADCAST && m.channelIndex == channel; };
|
||||
eraseIf(liveMessages, pred);
|
||||
eraseFirstMatch(liveMessages, pred);
|
||||
saveToFlash();
|
||||
}
|
||||
|
||||
void MessageStore::deleteAllMessagesInChannel(uint8_t channel)
|
||||
{
|
||||
auto pred = [channel](const StoredMessage &m) { return m.type == MessageType::BROADCAST && m.channelIndex == channel; };
|
||||
eraseIf(liveMessages, pred, false /* delete ALL, not just first */);
|
||||
eraseAllMatches(liveMessages, pred);
|
||||
saveToFlash();
|
||||
}
|
||||
|
||||
@@ -427,7 +422,7 @@ void MessageStore::deleteAllMessagesWithPeer(uint32_t peer)
|
||||
uint32_t other = (m.sender == local) ? m.dest : m.sender;
|
||||
return other == peer;
|
||||
};
|
||||
eraseIf(liveMessages, pred, false);
|
||||
eraseAllMatches(liveMessages, pred);
|
||||
saveToFlash();
|
||||
}
|
||||
|
||||
@@ -440,7 +435,7 @@ void MessageStore::deleteOldestMessageWithPeer(uint32_t peer)
|
||||
uint32_t other = (m.sender == nodeDB->getNodeNum()) ? m.dest : m.sender;
|
||||
return other == peer;
|
||||
};
|
||||
eraseIf(liveMessages, pred);
|
||||
eraseFirstMatch(liveMessages, pred);
|
||||
saveToFlash();
|
||||
}
|
||||
|
||||
|
||||
@@ -124,9 +124,6 @@ class MessageStore
|
||||
// Allocate text into pool (used by sender-side code)
|
||||
static uint16_t storeText(const char *src, size_t len);
|
||||
|
||||
// Used when loading from flash to rebuild the text pool
|
||||
static uint16_t rebuildTextFromFlash(const char *src, size_t len);
|
||||
|
||||
private:
|
||||
std::deque<StoredMessage> liveMessages; // Single in-RAM message buffer (also used for persistence)
|
||||
std::string filename; // Flash filename for persistence
|
||||
|
||||
+10
-1
@@ -904,7 +904,16 @@ void Power::readPowerStatus()
|
||||
|
||||
// Notify any status instances that are observing us
|
||||
const PowerStatus powerStatus2 = PowerStatus(hasBattery, usbPowered, isChargingNow, batteryVoltageMv, batteryChargePercent);
|
||||
if (millis() > lastLogTime + 50 * 1000) {
|
||||
|
||||
// Log battery-presence transitions once; skip OptUnknown so we don't lie before the first probe.
|
||||
static OptionalBool prevHasBattery = OptUnknown;
|
||||
if (hasBattery != OptUnknown && hasBattery != prevHasBattery) {
|
||||
LOG_INFO("Power: battery hardware %s", hasBattery == OptTrue ? "detected" : "absent (USB-only)");
|
||||
prevHasBattery = hasBattery;
|
||||
}
|
||||
|
||||
// Periodic telemetry only emits when a battery is actually present (otherwise values are constant -1/0).
|
||||
if (hasBattery == OptTrue && !Throttle::isWithinTimespanMs(lastLogTime, 50 * 1000)) {
|
||||
LOG_DEBUG("Battery: usbPower=%d, isCharging=%d, batMv=%d, batPct=%d", powerStatus2.getHasUSB(),
|
||||
powerStatus2.getIsCharging(), powerStatus2.getBatteryVoltageMv(), powerStatus2.getBatteryChargePercent());
|
||||
lastLogTime = millis();
|
||||
|
||||
@@ -230,9 +230,9 @@ void RedirectablePrint::log_to_ble(const char *logLevel, const char *format, va_
|
||||
auto thread = concurrency::OSThread::currentThread;
|
||||
meshtastic_LogRecord logRecord = meshtastic_LogRecord_init_zero;
|
||||
logRecord.level = getLogLevel(logLevel);
|
||||
vsprintf(logRecord.message, format, arg);
|
||||
vsnprintf(logRecord.message, sizeof(logRecord.message), format, arg);
|
||||
if (thread)
|
||||
strcpy(logRecord.source, thread->ThreadName.c_str());
|
||||
strlcpy(logRecord.source, thread->ThreadName.c_str(), sizeof(logRecord.source));
|
||||
logRecord.time = getValidTime(RTCQuality::RTCQualityDevice, true);
|
||||
|
||||
auto buffer = std::unique_ptr<uint8_t[]>(new uint8_t[meshtastic_LogRecord_size]);
|
||||
|
||||
+10
-142
@@ -65,7 +65,6 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
#include "mesh/Default.h"
|
||||
#include "mesh/generated/meshtastic/deviceonly.pb.h"
|
||||
#include "modules/ExternalNotificationModule.h"
|
||||
#include "modules/TextMessageModule.h"
|
||||
#include "modules/WaypointModule.h"
|
||||
#include "sleep.h"
|
||||
#include "target_specific.h"
|
||||
@@ -231,6 +230,7 @@ void Screen::showOverlayBanner(BannerOverlayOptions banner_overlay_options)
|
||||
#endif
|
||||
// Store the message and set the expiration timestamp
|
||||
strncpy(NotificationRenderer::alertBannerMessage, banner_overlay_options.message, 255);
|
||||
NotificationRenderer::parseBannerMessageWithFonts(NotificationRenderer::alertBannerMessage);
|
||||
NotificationRenderer::alertBannerMessage[255] = '\0'; // Ensure null termination
|
||||
NotificationRenderer::alertBannerUntil =
|
||||
(banner_overlay_options.durationMs == 0) ? 0 : millis() + banner_overlay_options.durationMs;
|
||||
@@ -240,9 +240,9 @@ void Screen::showOverlayBanner(BannerOverlayOptions banner_overlay_options)
|
||||
NotificationRenderer::alertBannerCallback = banner_overlay_options.bannerCallback;
|
||||
NotificationRenderer::curSelected = banner_overlay_options.InitialSelected;
|
||||
NotificationRenderer::pauseBanner = false;
|
||||
NotificationRenderer::current_notification_type = notificationTypeEnum::selection_picker;
|
||||
NotificationRenderer::current_notification_type = banner_overlay_options.notificationType;
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
ui->setTargetFPS(60);
|
||||
updateUiFrame(ui);
|
||||
}
|
||||
@@ -264,7 +264,7 @@ void Screen::showNodePicker(const char *message, uint32_t durationMs, std::funct
|
||||
NotificationRenderer::current_notification_type = notificationTypeEnum::node_picker;
|
||||
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
ui->setTargetFPS(60);
|
||||
updateUiFrame(ui);
|
||||
}
|
||||
@@ -288,7 +288,7 @@ void Screen::showNumberPicker(const char *message, uint32_t durationMs, uint8_t
|
||||
NotificationRenderer::currentNumber = 0;
|
||||
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
ui->setTargetFPS(60);
|
||||
updateUiFrame(ui);
|
||||
}
|
||||
@@ -311,7 +311,7 @@ void Screen::showTextInput(const char *header, const char *initialText, uint32_t
|
||||
|
||||
// Set the overlay using the same pattern as other notification types
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
ui->setTargetFPS(60);
|
||||
updateUiFrame(ui);
|
||||
}
|
||||
@@ -696,7 +696,7 @@ void Screen::setup()
|
||||
static OverlayCallback overlays[] = {
|
||||
graphics::UIRenderer::drawNavigationBar // Custom indicator icons for each frame
|
||||
};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 1);
|
||||
|
||||
// Enable UTF-8 to display mapping
|
||||
dispdev->setFontTableLookupFunction(customFontTableLookup);
|
||||
@@ -1313,7 +1313,7 @@ void Screen::setFrames(FrameFocus focus)
|
||||
|
||||
// Add overlays: frame icons and alert banner)
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
|
||||
prevFrame = -1; // Force drawFavoriteNode to pick a new node (because our list just changed)
|
||||
|
||||
@@ -1643,138 +1643,6 @@ int Screen::handleStatusUpdate(const meshtastic::Status *arg)
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Handles when message is received; will jump to text message frame.
|
||||
int Screen::handleTextMessage(const meshtastic_MeshPacket *packet)
|
||||
{
|
||||
if (showingNormalScreen) {
|
||||
if (packet->from == 0) {
|
||||
// Outgoing message (likely sent from phone)
|
||||
devicestate.has_rx_text_message = false;
|
||||
memset(&devicestate.rx_text_message, 0, sizeof(devicestate.rx_text_message));
|
||||
hiddenFrames.textMessage = true;
|
||||
hasUnreadMessage = false; // Clear unread state when user replies
|
||||
|
||||
setFrames(FOCUS_PRESERVE); // Stay on same frame, silently update frame list
|
||||
} else {
|
||||
// Incoming message
|
||||
devicestate.has_rx_text_message = true; // Needed to include the message frame
|
||||
hasUnreadMessage = true; // Enables mail icon in the header
|
||||
setFrames(FOCUS_PRESERVE); // Refresh frame list without switching view (no-op during text_input)
|
||||
|
||||
// Only wake/force display if the configuration allows it
|
||||
if (shouldWakeOnReceivedMessage()) {
|
||||
setOn(true); // Wake up the screen first
|
||||
forceDisplay(); // Forces screen redraw
|
||||
}
|
||||
// === Prepare banner/popup content ===
|
||||
const meshtastic_NodeInfoLite *node = nodeDB->getMeshNode(packet->from);
|
||||
const meshtastic_Channel channel =
|
||||
channels.getByIndex(packet->channel ? packet->channel : channels.getPrimaryIndex());
|
||||
const char *longName = nodeInfoLiteHasUser(node) ? node->long_name : nullptr;
|
||||
|
||||
const char *msgRaw = reinterpret_cast<const char *>(packet->decoded.payload.bytes);
|
||||
|
||||
char banner[256];
|
||||
|
||||
bool isAlert = false;
|
||||
|
||||
if (moduleConfig.external_notification.alert_bell || moduleConfig.external_notification.alert_bell_vibra ||
|
||||
moduleConfig.external_notification.alert_bell_buzzer)
|
||||
// Check for bell character to determine if this message is an alert
|
||||
for (size_t i = 0; i < packet->decoded.payload.size && i < 100; i++) {
|
||||
if (msgRaw[i] == ASCII_BELL) {
|
||||
isAlert = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
// Unlike generic messages, alerts (when enabled via the ext notif module) ignore any
|
||||
// 'mute' preferences set to any specific node or channel.
|
||||
// If on-screen keyboard is active, show a transient popup over keyboard instead of interrupting it
|
||||
if (NotificationRenderer::current_notification_type == notificationTypeEnum::text_input) {
|
||||
// Wake and force redraw so popup is visible immediately
|
||||
if (shouldWakeOnReceivedMessage()) {
|
||||
setOn(true);
|
||||
forceDisplay();
|
||||
}
|
||||
|
||||
// Build popup: title = message source name, content = message text (sanitized)
|
||||
// Title
|
||||
char titleBuf[64] = {0};
|
||||
if (longName && longName[0]) {
|
||||
// Sanitize sender name
|
||||
std::string t = sanitizeString(longName);
|
||||
strncpy(titleBuf, t.c_str(), sizeof(titleBuf) - 1);
|
||||
} else {
|
||||
strncpy(titleBuf, "Message", sizeof(titleBuf) - 1);
|
||||
}
|
||||
|
||||
// Content: payload bytes may not be null-terminated, remove ASCII_BELL and sanitize
|
||||
char content[256] = {0};
|
||||
{
|
||||
std::string raw;
|
||||
raw.reserve(packet->decoded.payload.size);
|
||||
for (size_t i = 0; i < packet->decoded.payload.size; ++i) {
|
||||
char c = msgRaw[i];
|
||||
if (c == ASCII_BELL)
|
||||
continue; // strip bell
|
||||
raw.push_back(c);
|
||||
}
|
||||
std::string sanitized = sanitizeString(raw);
|
||||
strncpy(content, sanitized.c_str(), sizeof(content) - 1);
|
||||
}
|
||||
|
||||
NotificationRenderer::showKeyboardMessagePopupWithTitle(titleBuf, content, 3000);
|
||||
|
||||
// Maintain existing buzzer behavior on M5 if applicable
|
||||
#if defined(M5STACK_UNITC6L)
|
||||
if (config.device.buzzer_mode != meshtastic_Config_DeviceConfig_BuzzerMode_DIRECT_MSG_ONLY ||
|
||||
(isAlert && moduleConfig.external_notification.alert_bell_buzzer) ||
|
||||
(!isBroadcast(packet->to) && isToUs(packet))) {
|
||||
playLongBeep();
|
||||
}
|
||||
#endif
|
||||
} else {
|
||||
// No keyboard active: use regular banner flow, respecting mute settings
|
||||
if (isAlert) {
|
||||
if (longName && longName[0]) {
|
||||
snprintf(banner, sizeof(banner), "Alert Received from\n%s", longName);
|
||||
} else {
|
||||
strcpy(banner, "Alert Received");
|
||||
}
|
||||
screen->showSimpleBanner(banner, 3000);
|
||||
} else if (!channel.settings.has_module_settings || !channel.settings.module_settings.is_muted) {
|
||||
if (longName && longName[0]) {
|
||||
if (currentResolution == ScreenResolution::UltraLow) {
|
||||
strcpy(banner, "New Message");
|
||||
} else {
|
||||
snprintf(banner, sizeof(banner), "New Message from\n%s", longName);
|
||||
}
|
||||
} else {
|
||||
strcpy(banner, "New Message");
|
||||
}
|
||||
#if defined(M5STACK_UNITC6L)
|
||||
screen->setOn(true);
|
||||
screen->showSimpleBanner(banner, 1500);
|
||||
if (config.device.buzzer_mode != meshtastic_Config_DeviceConfig_BuzzerMode_DIRECT_MSG_ONLY ||
|
||||
(isAlert && moduleConfig.external_notification.alert_bell_buzzer) ||
|
||||
(!isBroadcast(packet->to) && isToUs(packet))) {
|
||||
// Beep if not in DIRECT_MSG_ONLY mode or if in DIRECT_MSG_ONLY mode and either
|
||||
// - packet contains an alert and alert bell buzzer is enabled
|
||||
// - packet is a non-broadcast that is addressed to this node
|
||||
playLongBeep();
|
||||
}
|
||||
#else
|
||||
screen->showSimpleBanner(banner, 3000);
|
||||
#endif
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
// Triggered by MeshModules
|
||||
int Screen::handleUIFrameEvent(const UIFrameEvent *event)
|
||||
{
|
||||
@@ -1820,7 +1688,7 @@ int Screen::handleInputEvent(const InputEvent *event)
|
||||
if (NotificationRenderer::current_notification_type == notificationTypeEnum::text_input) {
|
||||
NotificationRenderer::inEvent = *event;
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
setFastFramerate(); // Draw ASAP
|
||||
updateUiFrame(ui);
|
||||
return 0;
|
||||
@@ -1835,7 +1703,7 @@ int Screen::handleInputEvent(const InputEvent *event)
|
||||
if (NotificationRenderer::isOverlayBannerShowing()) {
|
||||
NotificationRenderer::inEvent = *event;
|
||||
static OverlayCallback overlays[] = {graphics::UIRenderer::drawNavigationBar, NotificationRenderer::drawBannercallback};
|
||||
ui->setOverlays(overlays, sizeof(overlays) / sizeof(overlays[0]));
|
||||
ui->setOverlays(overlays, 2);
|
||||
setFastFramerate(); // Draw ASAP
|
||||
updateUiFrame(ui);
|
||||
|
||||
|
||||
@@ -609,7 +609,6 @@ class Screen : public concurrency::OSThread
|
||||
|
||||
// Handle observer events
|
||||
int handleStatusUpdate(const meshtastic::Status *arg);
|
||||
int handleTextMessage(const meshtastic_MeshPacket *packet);
|
||||
int handleUIFrameEvent(const UIFrameEvent *arg);
|
||||
int handleInputEvent(const InputEvent *arg);
|
||||
int handleAdminMessage(AdminModule_ObserverData *arg);
|
||||
|
||||
@@ -88,6 +88,16 @@
|
||||
#endif
|
||||
#endif
|
||||
|
||||
// nRF52 flash optimization: re-route FONT_LARGE_LOCAL to the 16pt glyph so
|
||||
// the display-tier dispatch below picks up 16pt everywhere it would have used
|
||||
// 24pt. Drops the ~9.6 KB ArialMT_Plain_24 table from the linked binary.
|
||||
// Set MESHTASTIC_LARGE_FONT_24PT=1 in build_flags to opt out per variant
|
||||
// (undefined or 0 keeps the optimization on).
|
||||
#if defined(ARCH_NRF52) && (!defined(MESHTASTIC_LARGE_FONT_24PT) || MESHTASTIC_LARGE_FONT_24PT == 0)
|
||||
#undef FONT_LARGE_LOCAL
|
||||
#define FONT_LARGE_LOCAL FONT_MEDIUM_LOCAL
|
||||
#endif
|
||||
|
||||
#if (defined(USE_EINK) || defined(ILI9341_DRIVER) || defined(ILI9342_DRIVER) || defined(ST7701_CS) || defined(ST7735_CS) || \
|
||||
defined(ST7789_CS) || defined(USE_ST7789) || defined(HX8357_CS) || defined(ILI9488_CS) || defined(ST7796_CS) || \
|
||||
defined(USE_ST7796) || defined(HACKADAY_COMMUNICATOR)) && \
|
||||
|
||||
@@ -57,6 +57,70 @@ BannerOverlayOptions createStaticBannerOptions(const char *message, const MenuOp
|
||||
return bannerOptions;
|
||||
}
|
||||
|
||||
const StoredMessage *getNewestMessageForActiveThread()
|
||||
{
|
||||
const auto &messages = messageStore.getMessages();
|
||||
if (messages.empty()) {
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
const auto mode = graphics::MessageRenderer::getThreadMode();
|
||||
const int channel = graphics::MessageRenderer::getThreadChannel();
|
||||
const uint32_t peer = graphics::MessageRenderer::getThreadPeer();
|
||||
const uint32_t localNode = nodeDB->getNodeNum();
|
||||
|
||||
if (mode == graphics::MessageRenderer::ThreadMode::ALL) {
|
||||
return &messages.back();
|
||||
}
|
||||
|
||||
for (auto it = messages.rbegin(); it != messages.rend(); ++it) {
|
||||
const StoredMessage &m = *it;
|
||||
|
||||
if (mode == graphics::MessageRenderer::ThreadMode::CHANNEL) {
|
||||
if (m.type == MessageType::BROADCAST && static_cast<int>(m.channelIndex) == channel) {
|
||||
return &m;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
if (mode == graphics::MessageRenderer::ThreadMode::DIRECT) {
|
||||
if (m.type != MessageType::DM_TO_US) {
|
||||
continue;
|
||||
}
|
||||
const uint32_t other = (m.sender == localNode) ? m.dest : m.sender;
|
||||
if (other == peer) {
|
||||
return &m;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return nullptr;
|
||||
}
|
||||
|
||||
void launchReplyForMessage(const StoredMessage &message, bool freetext)
|
||||
{
|
||||
if (message.type == MessageType::BROADCAST || message.dest == NODENUM_BROADCAST) {
|
||||
if (freetext) {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(NODENUM_BROADCAST, message.channelIndex);
|
||||
} else {
|
||||
cannedMessageModule->LaunchWithDestination(NODENUM_BROADCAST, message.channelIndex);
|
||||
}
|
||||
return;
|
||||
}
|
||||
|
||||
const uint32_t localNode = nodeDB->getNodeNum();
|
||||
const uint32_t peer = (message.sender == localNode) ? message.dest : message.sender;
|
||||
if (peer == 0 || peer == NODENUM_BROADCAST) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (freetext) {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(peer);
|
||||
} else {
|
||||
cannedMessageModule->LaunchWithDestination(peer);
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
menuHandler::screenMenus menuHandler::menuQueue = MenuNone;
|
||||
@@ -594,9 +658,12 @@ void menuHandler::messageResponseMenu()
|
||||
|
||||
#ifdef HAS_I2S
|
||||
} else if (selected == Aloud) {
|
||||
const meshtastic_MeshPacket &mp = devicestate.rx_text_message;
|
||||
const char *msg = reinterpret_cast<const char *>(mp.decoded.payload.bytes);
|
||||
audioThread->readAloud(msg);
|
||||
if (const StoredMessage *latest = getNewestMessageForActiveThread()) {
|
||||
const char *msg = MessageStore::getText(*latest);
|
||||
if (msg && msg[0]) {
|
||||
audioThread->readAloud(msg);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
}
|
||||
};
|
||||
@@ -656,20 +723,12 @@ void menuHandler::replyMenu()
|
||||
|
||||
// Preset reply
|
||||
if (selected == ReplyPreset) {
|
||||
|
||||
if (mode == graphics::MessageRenderer::ThreadMode::CHANNEL) {
|
||||
cannedMessageModule->LaunchWithDestination(NODENUM_BROADCAST, ch);
|
||||
|
||||
} else if (mode == graphics::MessageRenderer::ThreadMode::DIRECT) {
|
||||
cannedMessageModule->LaunchWithDestination(peer);
|
||||
|
||||
} else {
|
||||
// Fallback for last received message
|
||||
if (devicestate.rx_text_message.to == NODENUM_BROADCAST) {
|
||||
cannedMessageModule->LaunchWithDestination(NODENUM_BROADCAST, devicestate.rx_text_message.channel);
|
||||
} else {
|
||||
cannedMessageModule->LaunchWithDestination(devicestate.rx_text_message.from);
|
||||
}
|
||||
} else if (const StoredMessage *latest = getNewestMessageForActiveThread()) {
|
||||
launchReplyForMessage(*latest, false);
|
||||
}
|
||||
|
||||
return;
|
||||
@@ -677,20 +736,12 @@ void menuHandler::replyMenu()
|
||||
|
||||
// Freetext reply
|
||||
if (selected == ReplyFreetext) {
|
||||
|
||||
if (mode == graphics::MessageRenderer::ThreadMode::CHANNEL) {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(NODENUM_BROADCAST, ch);
|
||||
|
||||
} else if (mode == graphics::MessageRenderer::ThreadMode::DIRECT) {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(peer);
|
||||
|
||||
} else {
|
||||
// Fallback for last received message
|
||||
if (devicestate.rx_text_message.to == NODENUM_BROADCAST) {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(NODENUM_BROADCAST, devicestate.rx_text_message.channel);
|
||||
} else {
|
||||
cannedMessageModule->LaunchFreetextWithDestination(devicestate.rx_text_message.from);
|
||||
}
|
||||
} else if (const StoredMessage *latest = getNewestMessageForActiveThread()) {
|
||||
launchReplyForMessage(*latest, true);
|
||||
}
|
||||
|
||||
return;
|
||||
|
||||
@@ -66,6 +66,110 @@ uint32_t pow_of_10(uint32_t n)
|
||||
return ret;
|
||||
}
|
||||
|
||||
char graphics::NotificationRenderer::alertBannerLines[MAX_LINES + 1][64] = {};
|
||||
uint8_t graphics::NotificationRenderer::alertBannerLineCount = 0;
|
||||
graphics::NotificationRenderer::BannerFont graphics::NotificationRenderer::alertBannerLineFonts[MAX_LINES + 1] = {};
|
||||
|
||||
static inline graphics::NotificationRenderer::BannerFont parseFontTagPrefix(const char *&p)
|
||||
{
|
||||
// Tags must be at the start of the line:
|
||||
// [S] small, [M] medium, [L] large
|
||||
if (p && p[0] == '[' && p[2] == ']' && p[1] != '\0') {
|
||||
char t = p[1];
|
||||
if (t == 'S') {
|
||||
p += 3;
|
||||
return graphics::NotificationRenderer::BANNER_FONT_SMALL;
|
||||
}
|
||||
if (t == 'M') {
|
||||
p += 3;
|
||||
return graphics::NotificationRenderer::BANNER_FONT_MEDIUM;
|
||||
}
|
||||
if (t == 'L') {
|
||||
p += 3;
|
||||
return graphics::NotificationRenderer::BANNER_FONT_LARGE;
|
||||
}
|
||||
}
|
||||
return graphics::NotificationRenderer::BANNER_FONT_DEFAULT;
|
||||
}
|
||||
|
||||
static inline const uint8_t *fontForBannerLine(graphics::NotificationRenderer::BannerFont f)
|
||||
{
|
||||
switch (f) {
|
||||
case graphics::NotificationRenderer::BANNER_FONT_SMALL:
|
||||
return FONT_SMALL;
|
||||
case graphics::NotificationRenderer::BANNER_FONT_MEDIUM:
|
||||
return FONT_MEDIUM;
|
||||
case graphics::NotificationRenderer::BANNER_FONT_LARGE:
|
||||
return FONT_LARGE;
|
||||
case graphics::NotificationRenderer::BANNER_FONT_DEFAULT:
|
||||
default:
|
||||
return FONT_SMALL;
|
||||
}
|
||||
}
|
||||
|
||||
static inline uint8_t effectiveLineHeightForBannerLine(graphics::NotificationRenderer::BannerFont f)
|
||||
{
|
||||
uint8_t height = FONT_HEIGHT_SMALL;
|
||||
switch (f) {
|
||||
case graphics::NotificationRenderer::BANNER_FONT_MEDIUM:
|
||||
height = FONT_HEIGHT_MEDIUM;
|
||||
break;
|
||||
case graphics::NotificationRenderer::BANNER_FONT_LARGE:
|
||||
height = FONT_HEIGHT_LARGE;
|
||||
break;
|
||||
case graphics::NotificationRenderer::BANNER_FONT_SMALL:
|
||||
case graphics::NotificationRenderer::BANNER_FONT_DEFAULT:
|
||||
default:
|
||||
height = FONT_HEIGHT_SMALL;
|
||||
break;
|
||||
}
|
||||
return (height > 3) ? (height - 3) : height;
|
||||
}
|
||||
|
||||
void graphics::NotificationRenderer::parseBannerMessageWithFonts(const char *message)
|
||||
{
|
||||
alertBannerLineCount = 0;
|
||||
for (uint8_t i = 0; i < (MAX_LINES + 1); i++) {
|
||||
alertBannerLines[i][0] = '\0';
|
||||
alertBannerLineFonts[i] = BANNER_FONT_DEFAULT;
|
||||
}
|
||||
|
||||
if (!message || !message[0]) {
|
||||
return;
|
||||
}
|
||||
|
||||
const char *p = message;
|
||||
|
||||
while (*p && alertBannerLineCount < (MAX_LINES + 1)) {
|
||||
const char *lineStart = p;
|
||||
while (*p && *p != '\n') {
|
||||
p++;
|
||||
}
|
||||
|
||||
char tmp[64] = {0};
|
||||
size_t len = (size_t)(p - lineStart);
|
||||
if (len > (sizeof(tmp) - 1)) {
|
||||
len = sizeof(tmp) - 1;
|
||||
}
|
||||
memcpy(tmp, lineStart, len);
|
||||
tmp[len] = '\0';
|
||||
|
||||
// Tag at start
|
||||
const char *tp = tmp;
|
||||
BannerFont f = parseFontTagPrefix(tp);
|
||||
alertBannerLineFonts[alertBannerLineCount] = f;
|
||||
|
||||
// Store stripped text
|
||||
strncpy(alertBannerLines[alertBannerLineCount], tp, sizeof(alertBannerLines[0]) - 1);
|
||||
alertBannerLines[alertBannerLineCount][sizeof(alertBannerLines[0]) - 1] = '\0';
|
||||
alertBannerLineCount++;
|
||||
|
||||
if (*p == '\n') {
|
||||
p++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Used on boot when a certificate is being created
|
||||
void NotificationRenderer::drawSSLScreen(OLEDDisplay *display, OLEDDisplayUiState *state, int16_t x, int16_t y)
|
||||
{
|
||||
@@ -375,23 +479,37 @@ void NotificationRenderer::drawAlertBannerOverlay(OLEDDisplay *display, OLEDDisp
|
||||
const char *lineStarts[MAX_LINES + 1] = {0};
|
||||
uint16_t lineCount = 0;
|
||||
char lineBuffer[40] = {0};
|
||||
bool useTaggedTextBanner =
|
||||
(current_notification_type == notificationTypeEnum::text_banner && alertBannerOptions == 0 && alertBannerLineCount > 0);
|
||||
|
||||
// Parse lines
|
||||
char *alertEnd = alertBannerMessage + strnlen(alertBannerMessage, sizeof(alertBannerMessage));
|
||||
lineStarts[lineCount] = alertBannerMessage;
|
||||
if (useTaggedTextBanner) {
|
||||
lineCount = std::min<uint8_t>(alertBannerLineCount, MAX_LINES);
|
||||
for (uint16_t i = 0; i < lineCount; i++) {
|
||||
lineStarts[i] = alertBannerLines[i];
|
||||
lineLengths[i] = strlen(lineStarts[i]);
|
||||
display->setFont(fontForBannerLine(alertBannerLineFonts[i]));
|
||||
lineWidths[i] = display->getStringWidth(lineStarts[i], lineLengths[i], true);
|
||||
if (lineWidths[i] > maxWidth)
|
||||
maxWidth = lineWidths[i];
|
||||
}
|
||||
} else {
|
||||
char *alertEnd = alertBannerMessage + strnlen(alertBannerMessage, sizeof(alertBannerMessage));
|
||||
lineStarts[lineCount] = alertBannerMessage;
|
||||
|
||||
while ((lineCount < MAX_LINES) && (lineStarts[lineCount] < alertEnd)) {
|
||||
lineStarts[lineCount + 1] = std::find((char *)lineStarts[lineCount], alertEnd, '\n');
|
||||
lineLengths[lineCount] = lineStarts[lineCount + 1] - lineStarts[lineCount];
|
||||
if (lineStarts[lineCount + 1][0] == '\n')
|
||||
lineStarts[lineCount + 1] += 1;
|
||||
lineWidths[lineCount] = display->getStringWidth(lineStarts[lineCount], lineLengths[lineCount], true);
|
||||
if (lineWidths[lineCount] > maxWidth)
|
||||
maxWidth = lineWidths[lineCount];
|
||||
lineCount++;
|
||||
while ((lineCount < MAX_LINES) && (lineStarts[lineCount] < alertEnd)) {
|
||||
lineStarts[lineCount + 1] = std::find((char *)lineStarts[lineCount], alertEnd, '\n');
|
||||
lineLengths[lineCount] = lineStarts[lineCount + 1] - lineStarts[lineCount];
|
||||
if (lineStarts[lineCount + 1][0] == '\n')
|
||||
lineStarts[lineCount + 1] += 1;
|
||||
lineWidths[lineCount] = display->getStringWidth(lineStarts[lineCount], lineLengths[lineCount], true);
|
||||
if (lineWidths[lineCount] > maxWidth)
|
||||
maxWidth = lineWidths[lineCount];
|
||||
lineCount++;
|
||||
}
|
||||
}
|
||||
|
||||
// Measure option widths
|
||||
display->setFont(FONT_SMALL);
|
||||
for (int i = 0; i < alertBannerOptions; i++) {
|
||||
optionWidths[i] = display->getStringWidth(optionsArrayPtr[i], strlen(optionsArrayPtr[i]), true);
|
||||
if (optionWidths[i] > maxWidth)
|
||||
@@ -505,6 +623,10 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
bool needs_bell = false;
|
||||
uint16_t lineWidths[totalLines] = {0};
|
||||
uint16_t lineLengths[totalLines] = {0};
|
||||
BannerFont lineFonts[totalLines] = {};
|
||||
uint8_t lineEffectiveHeights[totalLines] = {0};
|
||||
const char *renderLines[totalLines] = {0};
|
||||
bool useTaggedBannerFonts = (current_notification_type == notificationTypeEnum::text_banner && alertBannerOptions == 0);
|
||||
|
||||
if (maxWidth != 0)
|
||||
is_picker = true;
|
||||
@@ -517,11 +639,22 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
uint16_t widestLineWithBars = 0;
|
||||
|
||||
while (lines[lineCount] != nullptr) {
|
||||
auto newlinePointer = strchr(lines[lineCount], '\n');
|
||||
const char *renderText = lines[lineCount];
|
||||
BannerFont lineFont = BANNER_FONT_DEFAULT;
|
||||
if (useTaggedBannerFonts && lineCount < alertBannerLineCount) {
|
||||
renderText = alertBannerLines[lineCount];
|
||||
lineFont = alertBannerLineFonts[lineCount];
|
||||
}
|
||||
renderLines[lineCount] = renderText;
|
||||
lineFonts[lineCount] = lineFont;
|
||||
lineEffectiveHeights[lineCount] = effectiveLineHeightForBannerLine(lineFont);
|
||||
display->setFont(fontForBannerLine(lineFont));
|
||||
|
||||
auto newlinePointer = strchr(renderText, '\n');
|
||||
if (newlinePointer)
|
||||
lineLengths[lineCount] = (newlinePointer - lines[lineCount]); // Check for newlines first
|
||||
else // if the newline wasn't found, then pull string length from strlen
|
||||
lineLengths[lineCount] = strlen(lines[lineCount]);
|
||||
lineLengths[lineCount] = (newlinePointer - renderText);
|
||||
else
|
||||
lineLengths[lineCount] = strlen(renderText);
|
||||
|
||||
if (current_notification_type == notificationTypeEnum::node_picker) {
|
||||
char measureBuffer[64] = {0};
|
||||
@@ -533,7 +666,7 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
|
||||
// Consider extra width for signal bars on lines that contain "Signal:"
|
||||
uint16_t potentialWidth = lineWidths[lineCount];
|
||||
if (graphics::bannerSignalBars >= 0 && strncmp(lines[lineCount], "Signal:", 7) == 0) {
|
||||
if (graphics::bannerSignalBars >= 0 && strncmp(renderText, "Signal:", 7) == 0) {
|
||||
const int totalBars = 5;
|
||||
const int barWidth = 3;
|
||||
const int barSpacing = 2;
|
||||
@@ -569,8 +702,21 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
|
||||
uint16_t screenHeight = display->height();
|
||||
uint8_t effectiveLineHeight = FONT_HEIGHT_SMALL - 3;
|
||||
uint8_t visibleTotalLines = std::min<uint8_t>(lineCount, (screenHeight - vPadding * 2) / effectiveLineHeight);
|
||||
uint16_t contentHeight = visibleTotalLines * effectiveLineHeight;
|
||||
uint8_t visibleTotalLines = 0;
|
||||
uint16_t contentHeight = 0;
|
||||
const uint16_t availableHeight = (screenHeight > (vPadding * 2)) ? (screenHeight - vPadding * 2) : 0;
|
||||
for (uint8_t i = 0; i < lineCount; i++) {
|
||||
uint8_t thisLineHeight = lineEffectiveHeights[i] ? lineEffectiveHeights[i] : effectiveLineHeight;
|
||||
if (contentHeight + thisLineHeight > availableHeight) {
|
||||
break;
|
||||
}
|
||||
contentHeight += thisLineHeight;
|
||||
visibleTotalLines++;
|
||||
}
|
||||
if (visibleTotalLines == 0 && lineCount > 0) {
|
||||
visibleTotalLines = 1;
|
||||
contentHeight = lineEffectiveHeights[0] ? lineEffectiveHeights[0] : effectiveLineHeight;
|
||||
}
|
||||
uint16_t boxHeight = contentHeight + vPadding * 2;
|
||||
if (visibleTotalLines == 1) {
|
||||
boxHeight += (currentResolution == ScreenResolution::High) ? 4 : 3;
|
||||
@@ -616,15 +762,18 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
|
||||
// Draw Content
|
||||
int16_t lineY = boxTop + vPadding;
|
||||
for (int i = 0; i < lineCount; i++) {
|
||||
for (int i = 0; i < visibleTotalLines; i++) {
|
||||
display->setFont(fontForBannerLine(lineFonts[i]));
|
||||
int16_t thisLineHeight = lineEffectiveHeights[i] ? lineEffectiveHeights[i] : effectiveLineHeight;
|
||||
int16_t textX = boxLeft + (boxWidth - lineWidths[i]) / 2;
|
||||
if (needs_bell && i == 0) {
|
||||
int bellY = lineY + (FONT_HEIGHT_SMALL - 8) / 2;
|
||||
int fontHeight = thisLineHeight + 3;
|
||||
int bellY = lineY + (fontHeight - 8) / 2;
|
||||
display->drawXbm(textX - 10, bellY, 8, 8, bell_alert);
|
||||
display->drawXbm(textX + lineWidths[i] + 2, bellY, 8, 8, bell_alert);
|
||||
}
|
||||
char lineBuffer[lineLengths[i] + 1];
|
||||
strncpy(lineBuffer, lines[i], lineLengths[i]);
|
||||
strncpy(lineBuffer, renderLines[i], lineLengths[i]);
|
||||
lineBuffer[lineLengths[i]] = '\0';
|
||||
// Determine if this is a pop-up or a pick list
|
||||
if (alertBannerOptions > 0 && i == 0) {
|
||||
@@ -658,7 +807,7 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
display->drawString(textX, lineY - yOffset, lineBuffer);
|
||||
}
|
||||
display->setColor(WHITE);
|
||||
lineY += (effectiveLineHeight - 2 - background_yOffset);
|
||||
lineY += (thisLineHeight - 2 - background_yOffset);
|
||||
} else {
|
||||
// Pop-up
|
||||
// If this is the Signal line, center text + bars as one group
|
||||
@@ -716,7 +865,7 @@ void NotificationRenderer::drawNotificationBox(OLEDDisplay *display, OLEDDisplay
|
||||
display->drawString(textX, lineY, lineBuffer);
|
||||
}
|
||||
}
|
||||
lineY += (effectiveLineHeight);
|
||||
lineY += thisLineHeight;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
@@ -31,6 +31,12 @@ class NotificationRenderer
|
||||
|
||||
static bool pauseBanner;
|
||||
|
||||
enum BannerFont : uint8_t { BANNER_FONT_DEFAULT = 0, BANNER_FONT_SMALL, BANNER_FONT_MEDIUM, BANNER_FONT_LARGE };
|
||||
|
||||
static char alertBannerLines[MAX_LINES + 1][64]; // parsed text per line
|
||||
static uint8_t alertBannerLineCount;
|
||||
static BannerFont alertBannerLineFonts[MAX_LINES + 1];
|
||||
static void parseBannerMessageWithFonts(const char *message);
|
||||
static void resetBanner();
|
||||
static void showKeyboardMessagePopupWithTitle(const char *title, const char *content, uint32_t durationMs);
|
||||
static void drawBannercallback(OLEDDisplay *display, OLEDDisplayUiState *state);
|
||||
|
||||
@@ -5,9 +5,8 @@
|
||||
Shows the latest incoming text message, as well as sender.
|
||||
Both broadcast and direct messages will be shown here, from all channels.
|
||||
|
||||
This module doesn't doesn't use the devicestate.rx_text_message,' as this is overwritten to contain outgoing messages
|
||||
This module doesn't collect its own text message. Instead, the WindowManager stores the most recent incoming text message.
|
||||
This is available to any interested modules (SingeMessageApplet, NotificationApplet etc.) via InkHUD::latestMessage
|
||||
This is available to any interested modules (SingleMessageApplet, NotificationApplet etc.) via InkHUD::latestMessage
|
||||
|
||||
We do still receive notifications from the text message module though,
|
||||
to know when a new message has arrived, and trigger the update.
|
||||
@@ -46,4 +45,4 @@ class AllMessageApplet : public Applet
|
||||
|
||||
} // namespace NicheGraphics::InkHUD
|
||||
|
||||
#endif
|
||||
#endif
|
||||
|
||||
@@ -3,11 +3,10 @@
|
||||
/*
|
||||
|
||||
Shows the latest incoming *Direct Message* (DM), as well as sender.
|
||||
This compliments the threaded message applets
|
||||
This complements the threaded message applets
|
||||
|
||||
This module doesn't doesn't use the devicestate.rx_text_message,' as this is overwritten to contain outgoing messages
|
||||
This module doesn't collect its own text message. Instead, the WindowManager stores the most recent incoming text message.
|
||||
This is available to any interested modules (SingeMessageApplet, NotificationApplet etc.) via InkHUD::latestMessage
|
||||
This is available to any interested modules (SingleMessageApplet, NotificationApplet etc.) via InkHUD::latestMessage
|
||||
|
||||
We do still receive notifications from the text message module though,
|
||||
to know when a new message has arrived, and trigger the update.
|
||||
@@ -46,4 +45,4 @@ class DMApplet : public Applet
|
||||
|
||||
} // namespace NicheGraphics::InkHUD
|
||||
|
||||
#endif
|
||||
#endif
|
||||
|
||||
@@ -525,7 +525,7 @@ int InkHUD::Events::beforeReboot(void *unused)
|
||||
// Callback when a new text message is received
|
||||
// Caches the most recently received message, for use by applets
|
||||
// Rx does not trigger a save to flash, however the data *will* be saved alongside other during shutdown, etc.
|
||||
// Note: this is different from devicestate.rx_text_message, which may contain an *outgoing* message
|
||||
// Note: this is intentionally separate from device-state message fields.
|
||||
int InkHUD::Events::onReceiveTextMessage(const meshtastic_MeshPacket *packet)
|
||||
{
|
||||
// Short circuit: don't store outgoing messages
|
||||
|
||||
@@ -121,8 +121,7 @@ class Persistence
|
||||
|
||||
// Most recently received text message
|
||||
// Value is updated by InkHUD::WindowManager, as a courtesy to applets
|
||||
// Note: different from devicestate.rx_text_message,
|
||||
// which may contain an *outgoing message* to broadcast
|
||||
// InkHUD keeps its own latest-message cache for applets.
|
||||
struct LatestMessage {
|
||||
MessageStore::Message broadcast; // Most recent message received broadcast
|
||||
MessageStore::Message dm; // Most recent received DM
|
||||
|
||||
@@ -464,7 +464,7 @@ Most recently received text message
|
||||
|
||||
Collected here, so various user applets don't all have to store their own copy of this info.
|
||||
|
||||
We are unable to use `devicestate.rx_text_message` for this purpose, because:
|
||||
We keep this separate latest-message cache for this purpose, because:
|
||||
|
||||
- it is cleared by an outgoing text message
|
||||
- we want to store both a recent broadcast and a recent DM
|
||||
|
||||
+10
-2
@@ -245,7 +245,7 @@ const char *getDeviceName()
|
||||
uint32_t timeLastPowered = 0;
|
||||
|
||||
static OSThread *powerFSMthread;
|
||||
OSThread *ambientLightingThread;
|
||||
AmbientLightingThread *ambientLightingThread;
|
||||
|
||||
RadioLibHal *RadioLibHAL = NULL;
|
||||
|
||||
@@ -801,7 +801,15 @@ void setup()
|
||||
#endif
|
||||
#else
|
||||
// ESP32
|
||||
#if defined(HW_SPI1_DEVICE)
|
||||
#if defined(USE_HALOW_RADIO) && !defined(USE_SX1262) && !defined(USE_RF95) && !defined(USE_LR11X0)
|
||||
// HaLow-only ESP32 variant: Morse's wlan_hal claims SPI2_HOST itself via
|
||||
// ESP-IDF's spi_bus_initialize() (lib/MorseWlan/src/wlan_hal.c). Calling
|
||||
// Arduino SPI.begin() on the default LORA_* pins both (a) collides on
|
||||
// SPI2_HOST and (b) reconfigures GPIO 5 as SPI clock, clobbering the
|
||||
// HaLow BUSY input. Skip Arduino's bus init — there's no LoRa, no
|
||||
// display, no SD card on this board.
|
||||
LOG_DEBUG("Skipping Arduino SPI.begin() — HaLow owns SPI2_HOST");
|
||||
#elif defined(HW_SPI1_DEVICE)
|
||||
SPI1.begin(LORA_SCK, LORA_MISO, LORA_MOSI, LORA_CS);
|
||||
LOG_DEBUG("SPI1.begin(SCK=%d, MISO=%d, MOSI=%d, NSS=%d)", LORA_SCK, LORA_MISO, LORA_MOSI, LORA_CS);
|
||||
SPI1.setFrequency(4000000);
|
||||
|
||||
+158
-57
@@ -25,6 +25,7 @@
|
||||
#include "mesh/generated/meshtastic/deviceonly_legacy.pb.h"
|
||||
#include "meshUtils.h"
|
||||
#include "modules/NeighborInfoModule.h"
|
||||
#include "xmodem.h"
|
||||
#include <ErriezCRC32.h>
|
||||
#include <algorithm>
|
||||
#include <pb_decode.h>
|
||||
@@ -81,6 +82,14 @@ static unsigned char userprefs_admin_key_1[] = USERPREFS_USE_ADMIN_KEY_1;
|
||||
static unsigned char userprefs_admin_key_2[] = USERPREFS_USE_ADMIN_KEY_2;
|
||||
#endif
|
||||
|
||||
// Weak empty variant initialization function.
|
||||
// May be redefined by variant files.
|
||||
void variantDefaultConfig() __attribute__((weak));
|
||||
void variantDefaultConfig() {}
|
||||
|
||||
void variantDefaultModuleConfig() __attribute__((weak));
|
||||
void variantDefaultModuleConfig() {}
|
||||
|
||||
#ifdef HELTEC_MESH_NODE_T114
|
||||
|
||||
uint32_t read8(uint8_t bits, uint8_t dummy, uint8_t cs, uint8_t sck, uint8_t mosi, uint8_t dc, uint8_t rst)
|
||||
@@ -152,6 +161,25 @@ uint32_t get_st7789_id(uint8_t cs, uint8_t sck, uint8_t mosi, uint8_t dc, uint8_
|
||||
|
||||
#endif
|
||||
|
||||
// When armed by loadFromDisk, the decode callback writes satellite entries
|
||||
// straight into these maps instead of the temp vectors. Nullptr = legacy
|
||||
// push_back-to-vector path for backup/restore and other decoders.
|
||||
namespace
|
||||
{
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
std::map<NodeNum, meshtastic_PositionLite> *s_decodePositionsTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
std::map<NodeNum, meshtastic_DeviceMetrics> *s_decodeTelemetryTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
std::map<NodeNum, meshtastic_EnvironmentMetrics> *s_decodeEnvironmentTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
std::map<NodeNum, meshtastic_StatusMessage> *s_decodeStatusTarget = nullptr;
|
||||
#endif
|
||||
} // namespace
|
||||
|
||||
bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostream, const pb_field_t *field)
|
||||
{
|
||||
const auto *iter = reinterpret_cast<const pb_field_iter_t *>(field);
|
||||
@@ -166,10 +194,10 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (istream) {
|
||||
meshtastic_NodeInfoLite node;
|
||||
if (istream && istream->bytes_left) {
|
||||
meshtastic_NodeInfoLite node = meshtastic_NodeInfoLite_init_zero;
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeInfoLite> *>(iter->pData);
|
||||
if (istream->bytes_left && pb_decode(istream, meshtastic_NodeInfoLite_fields, &node))
|
||||
if (pb_decode(istream, meshtastic_NodeInfoLite_fields, &node))
|
||||
vec->push_back(node);
|
||||
}
|
||||
return true;
|
||||
@@ -184,11 +212,19 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (istream) {
|
||||
meshtastic_NodePositionEntry entry;
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodePositionEntry> *>(iter->pData);
|
||||
if (istream->bytes_left && pb_decode(istream, meshtastic_NodePositionEntry_fields, &entry))
|
||||
if (istream && istream->bytes_left) {
|
||||
meshtastic_NodePositionEntry entry = meshtastic_NodePositionEntry_init_zero;
|
||||
if (pb_decode(istream, meshtastic_NodePositionEntry_fields, &entry)) {
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
if (s_decodePositionsTarget) {
|
||||
if (entry.has_position)
|
||||
(*s_decodePositionsTarget)[entry.num] = entry.position;
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodePositionEntry> *>(iter->pData);
|
||||
vec->push_back(entry);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -202,11 +238,19 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (istream) {
|
||||
meshtastic_NodeTelemetryEntry entry;
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeTelemetryEntry> *>(iter->pData);
|
||||
if (istream->bytes_left && pb_decode(istream, meshtastic_NodeTelemetryEntry_fields, &entry))
|
||||
if (istream && istream->bytes_left) {
|
||||
meshtastic_NodeTelemetryEntry entry = meshtastic_NodeTelemetryEntry_init_zero;
|
||||
if (pb_decode(istream, meshtastic_NodeTelemetryEntry_fields, &entry)) {
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
if (s_decodeTelemetryTarget) {
|
||||
if (entry.has_device_metrics)
|
||||
(*s_decodeTelemetryTarget)[entry.num] = entry.device_metrics;
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeTelemetryEntry> *>(iter->pData);
|
||||
vec->push_back(entry);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -220,11 +264,19 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (istream) {
|
||||
meshtastic_NodeStatusEntry entry;
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeStatusEntry> *>(iter->pData);
|
||||
if (istream->bytes_left && pb_decode(istream, meshtastic_NodeStatusEntry_fields, &entry))
|
||||
if (istream && istream->bytes_left) {
|
||||
meshtastic_NodeStatusEntry entry = meshtastic_NodeStatusEntry_init_zero;
|
||||
if (pb_decode(istream, meshtastic_NodeStatusEntry_fields, &entry)) {
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
if (s_decodeStatusTarget) {
|
||||
if (entry.has_status)
|
||||
(*s_decodeStatusTarget)[entry.num] = entry.status;
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeStatusEntry> *>(iter->pData);
|
||||
vec->push_back(entry);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -238,11 +290,19 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
return false;
|
||||
}
|
||||
}
|
||||
if (istream) {
|
||||
meshtastic_NodeEnvironmentEntry entry;
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeEnvironmentEntry> *>(iter->pData);
|
||||
if (istream->bytes_left && pb_decode(istream, meshtastic_NodeEnvironmentEntry_fields, &entry))
|
||||
if (istream && istream->bytes_left) {
|
||||
meshtastic_NodeEnvironmentEntry entry = meshtastic_NodeEnvironmentEntry_init_zero;
|
||||
if (pb_decode(istream, meshtastic_NodeEnvironmentEntry_fields, &entry)) {
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
if (s_decodeEnvironmentTarget) {
|
||||
if (entry.has_environment_metrics)
|
||||
(*s_decodeEnvironmentTarget)[entry.num] = entry.environment_metrics;
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
auto *vec = static_cast<std::vector<meshtastic_NodeEnvironmentEntry> *>(iter->pData);
|
||||
vec->push_back(entry);
|
||||
}
|
||||
}
|
||||
return true;
|
||||
}
|
||||
@@ -251,6 +311,42 @@ bool meshtastic_NodeDatabase_callback(pb_istream_t *istream, pb_ostream_t *ostre
|
||||
}
|
||||
}
|
||||
|
||||
void NodeDB::armNodeDatabaseDecodeTargets()
|
||||
{
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
nodePositions.clear();
|
||||
s_decodePositionsTarget = &nodePositions;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
nodeTelemetry.clear();
|
||||
s_decodeTelemetryTarget = &nodeTelemetry;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
nodeEnvironment.clear();
|
||||
s_decodeEnvironmentTarget = &nodeEnvironment;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
nodeStatus.clear();
|
||||
s_decodeStatusTarget = &nodeStatus;
|
||||
#endif
|
||||
}
|
||||
|
||||
void NodeDB::disarmNodeDatabaseDecodeTargets()
|
||||
{
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
s_decodePositionsTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
s_decodeTelemetryTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
s_decodeEnvironmentTarget = nullptr;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
s_decodeStatusTarget = nullptr;
|
||||
#endif
|
||||
}
|
||||
|
||||
/** The current change # for radio settings. Starts at 0 on boot and any time the radio settings
|
||||
* might have changed is incremented. Allows others to detect they might now be on a new channel.
|
||||
*/
|
||||
@@ -904,6 +1000,8 @@ void NodeDB::installDefaultConfig(bool preserveKey = false)
|
||||
#endif
|
||||
|
||||
initConfigIntervals();
|
||||
variantDefaultConfig();
|
||||
variantDefaultModuleConfig();
|
||||
}
|
||||
|
||||
void NodeDB::initConfigIntervals()
|
||||
@@ -1161,7 +1259,6 @@ void NodeDB::resetNodes(bool keepFavorites)
|
||||
std::fill(nodeDatabase.nodes.begin() + 1, nodeDatabase.nodes.end(), meshtastic_NodeInfoLite());
|
||||
}
|
||||
(void)ourNum;
|
||||
devicestate.has_rx_text_message = false;
|
||||
devicestate.has_rx_waypoint = false;
|
||||
saveNodeDatabaseToDisk();
|
||||
saveDeviceStateToDisk();
|
||||
@@ -1368,7 +1465,6 @@ void NodeDB::installDefaultDeviceState()
|
||||
devicestate.version = DEVICESTATE_CUR_VER;
|
||||
devicestate.receive_queue_count = 0; // Not yet implemented FIXME
|
||||
devicestate.has_rx_waypoint = false;
|
||||
devicestate.has_rx_text_message = false;
|
||||
|
||||
generatePacketId(); // FIXME - ugly way to init current_packet_id;
|
||||
|
||||
@@ -1510,6 +1606,19 @@ void NodeDB::loadFromDisk()
|
||||
}
|
||||
|
||||
#endif
|
||||
// Arm the direct-into-map decode so satellite entries skip the temp vectors.
|
||||
{
|
||||
concurrency::LockGuard guard(&satelliteMutex);
|
||||
armNodeDatabaseDecodeTargets();
|
||||
}
|
||||
struct Disarm {
|
||||
NodeDB &self;
|
||||
~Disarm() { self.disarmNodeDatabaseDecodeTargets(); }
|
||||
} disarm{*this};
|
||||
|
||||
// Avoid push_back's power-of-2 capacity growth wasting RAM at small N.
|
||||
nodeDatabase.nodes.reserve(MAX_NUM_NODES);
|
||||
|
||||
auto state = loadProto(nodeDatabaseFileName, getMaxNodesAllocatedSize(), sizeof(meshtastic_NodeDatabase),
|
||||
&meshtastic_NodeDatabase_msg, &nodeDatabase);
|
||||
if (nodeDatabase.version < DEVICESTATE_MIN_VER) {
|
||||
@@ -1523,50 +1632,33 @@ void NodeDB::loadFromDisk()
|
||||
} else {
|
||||
meshNodes = &nodeDatabase.nodes;
|
||||
numMeshNodes = nodeDatabase.nodes.size();
|
||||
// Hydrate the satellite maps; the on-disk vectors stay empty in steady
|
||||
// state and are repopulated only at save time.
|
||||
concurrency::LockGuard guard(&satelliteMutex);
|
||||
// Counts computed outside LOG_INFO() so cppcheck doesn't choke on #if in macro args.
|
||||
const unsigned posCount =
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
nodePositions.clear();
|
||||
nodePositions.reserve(nodeDatabase.positions.size());
|
||||
for (const auto &entry : nodeDatabase.positions) {
|
||||
if (entry.has_position)
|
||||
nodePositions[entry.num] = entry.position;
|
||||
}
|
||||
nodeDatabase.positions.clear();
|
||||
nodeDatabase.positions.shrink_to_fit();
|
||||
(unsigned)nodePositions.size();
|
||||
#else
|
||||
0u;
|
||||
#endif
|
||||
const unsigned telCount =
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
nodeTelemetry.clear();
|
||||
nodeTelemetry.reserve(nodeDatabase.telemetry.size());
|
||||
for (const auto &entry : nodeDatabase.telemetry) {
|
||||
if (entry.has_device_metrics)
|
||||
nodeTelemetry[entry.num] = entry.device_metrics;
|
||||
}
|
||||
nodeDatabase.telemetry.clear();
|
||||
nodeDatabase.telemetry.shrink_to_fit();
|
||||
(unsigned)nodeTelemetry.size();
|
||||
#else
|
||||
0u;
|
||||
#endif
|
||||
const unsigned envCount =
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
nodeEnvironment.clear();
|
||||
nodeEnvironment.reserve(nodeDatabase.environment.size());
|
||||
for (const auto &entry : nodeDatabase.environment) {
|
||||
if (entry.has_environment_metrics)
|
||||
nodeEnvironment[entry.num] = entry.environment_metrics;
|
||||
}
|
||||
nodeDatabase.environment.clear();
|
||||
nodeDatabase.environment.shrink_to_fit();
|
||||
(unsigned)nodeEnvironment.size();
|
||||
#else
|
||||
0u;
|
||||
#endif
|
||||
const unsigned statusCount =
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
nodeStatus.clear();
|
||||
nodeStatus.reserve(nodeDatabase.status.size());
|
||||
for (const auto &entry : nodeDatabase.status) {
|
||||
if (entry.has_status)
|
||||
nodeStatus[entry.num] = entry.status;
|
||||
}
|
||||
nodeDatabase.status.clear();
|
||||
nodeDatabase.status.shrink_to_fit();
|
||||
(unsigned)nodeStatus.size();
|
||||
#else
|
||||
0u;
|
||||
#endif
|
||||
LOG_INFO("Loaded saved nodedatabase version %d, with nodes count: %d", nodeDatabase.version, nodeDatabase.nodes.size());
|
||||
LOG_INFO("Loaded saved nodedatabase v%d: %d nodes, %u pos, %u tel, %u env, %u status", nodeDatabase.version,
|
||||
nodeDatabase.nodes.size(), posCount, telCount, envCount, statusCount);
|
||||
}
|
||||
|
||||
if (numMeshNodes > MAX_NUM_NODES) {
|
||||
@@ -1844,6 +1936,15 @@ bool NodeDB::saveNodeDatabaseToDisk()
|
||||
return false;
|
||||
}
|
||||
|
||||
// Defer (don't fail) while xmodem holds the prefs file handle. Returning false
|
||||
// would propagate through saveToDisk() and trigger fsFormat() mid-transfer.
|
||||
#ifdef FSCom
|
||||
if (xModem.isBusy()) {
|
||||
LOG_DEBUG("Deferring NodeDB save: xmodem transfer in progress");
|
||||
return true;
|
||||
}
|
||||
#endif
|
||||
|
||||
#ifdef FSCom
|
||||
spiLock->lock();
|
||||
FSCom.mkdir("/prefs");
|
||||
|
||||
+12
-7
@@ -4,9 +4,9 @@
|
||||
#include <Arduino.h>
|
||||
#include <algorithm>
|
||||
#include <assert.h>
|
||||
#include <map>
|
||||
#include <pb_encode.h>
|
||||
#include <string>
|
||||
#include <unordered_map>
|
||||
#include <vector>
|
||||
|
||||
#include "MeshTypes.h"
|
||||
@@ -170,19 +170,19 @@ class NodeDB
|
||||
Observable<const meshtastic::NodeStatus *> newStatus;
|
||||
pb_size_t numMeshNodes;
|
||||
|
||||
// Satellite per-NodeNum maps for data we used to inline into NodeInfoLite,
|
||||
// gated by MESHTASTIC_EXCLUDE_*DB so STM32WL can omit them.
|
||||
// Satellite per-NodeNum maps. std::map avoids unordered_map's bucket-array
|
||||
// preallocation; O(log N) lookup is fine at these sizes.
|
||||
#if !MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
std::unordered_map<NodeNum, meshtastic_PositionLite> nodePositions;
|
||||
std::map<NodeNum, meshtastic_PositionLite> nodePositions;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
std::unordered_map<NodeNum, meshtastic_DeviceMetrics> nodeTelemetry;
|
||||
std::map<NodeNum, meshtastic_DeviceMetrics> nodeTelemetry;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
std::unordered_map<NodeNum, meshtastic_EnvironmentMetrics> nodeEnvironment;
|
||||
std::map<NodeNum, meshtastic_EnvironmentMetrics> nodeEnvironment;
|
||||
#endif
|
||||
#if !MESHTASTIC_EXCLUDE_STATUSDB
|
||||
std::unordered_map<NodeNum, meshtastic_StatusMessage> nodeStatus;
|
||||
std::map<NodeNum, meshtastic_StatusMessage> nodeStatus;
|
||||
#endif
|
||||
|
||||
bool keyIsLowEntropy = false;
|
||||
@@ -429,6 +429,11 @@ class NodeDB
|
||||
// the legacy descriptor and copies entries into the v25 layout. Caller
|
||||
// is responsible for save / install-default on the result.
|
||||
bool migrateLegacyNodeDatabase();
|
||||
|
||||
// Route satellite-store decode entries straight into our maps instead of
|
||||
// temp vectors. Must be paired — disarm before any other NodeDatabase decode.
|
||||
void armNodeDatabaseDecodeTargets();
|
||||
void disarmNodeDatabaseDecodeTargets();
|
||||
};
|
||||
|
||||
extern NodeDB *nodeDB;
|
||||
|
||||
@@ -9,8 +9,8 @@
|
||||
#include "Throttle.h"
|
||||
|
||||
#define PACKETHISTORY_MAX \
|
||||
max((u_int32_t)(MAX_NUM_NODES * 2.0), \
|
||||
(u_int32_t)100) // x2..3 Should suffice. Empirical setup. 16B per record malloc'ed, but no less than 100
|
||||
max((uint32_t)(MAX_NUM_NODES * 2.0), \
|
||||
(uint32_t)100) // x2..3 Should suffice. Empirical setup. 16B per record malloc'ed, but no less than 100
|
||||
|
||||
#define RECENT_WARN_AGE (10 * 60 * 1000L) // Warn if the packet that gets removed was more recent than 10 min
|
||||
|
||||
|
||||
+158
-189
@@ -62,7 +62,7 @@ void PhoneAPI::handleStartConfig()
|
||||
onConfigStart();
|
||||
|
||||
// even if we were already connected - restart our state machine
|
||||
if (config_nonce == SPECIAL_NONCE_ONLY_NODES || config_nonce == SPECIAL_NONCE_GRADIENT_ONLY_NODES) {
|
||||
if (config_nonce == SPECIAL_NONCE_ONLY_NODES) {
|
||||
// If client only wants node info, jump directly to sending nodes
|
||||
state = STATE_SEND_OWN_NODEINFO;
|
||||
LOG_INFO("Client only wants node info, skipping other config");
|
||||
@@ -138,6 +138,7 @@ void PhoneAPI::close()
|
||||
replayTelemetryIndex = 0;
|
||||
replayEnvironmentIndex = 0;
|
||||
replayStatusIndex = 0;
|
||||
replayPhase = REPLAY_PHASE_IDLE;
|
||||
}
|
||||
packetForPhone = NULL;
|
||||
filesManifest.clear();
|
||||
@@ -320,7 +321,7 @@ size_t PhoneAPI::getFromRadio(uint8_t *buf)
|
||||
nodeInfoForPhone.num = 0;
|
||||
}
|
||||
}
|
||||
if (config_nonce == SPECIAL_NONCE_ONLY_NODES || config_nonce == SPECIAL_NONCE_GRADIENT_ONLY_NODES) {
|
||||
if (config_nonce == SPECIAL_NONCE_ONLY_NODES) {
|
||||
// If client only wants node info, jump directly to sending nodes
|
||||
state = STATE_SEND_OTHER_NODEINFOS;
|
||||
onNowHasData(0);
|
||||
@@ -535,135 +536,16 @@ size_t PhoneAPI::getFromRadio(uint8_t *buf)
|
||||
// Just in case we stored a different user.id in the past, but should never happen going forward
|
||||
sprintf(infoToSend.user.id, "!%08x", infoToSend.num);
|
||||
|
||||
// Logging this really slows down sending nodes on initial connection because the serial console is so slow, so only
|
||||
// uncomment if you really need to:
|
||||
// LOG_INFO("nodeinfo: num=0x%x, lastseen=%u, id=%s, name=%s", nodeInfoForPhone.num, nodeInfoForPhone.last_heard,
|
||||
// nodeInfoForPhone.user.id, nodeInfoForPhone.user.long_name);
|
||||
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_node_info_tag;
|
||||
fromRadioScratch.node_info = infoToSend;
|
||||
prefetchNodeInfos();
|
||||
} else {
|
||||
LOG_DEBUG("Done sending %d of %d nodeinfos millis=%u", readIndex, nodeDB->getNumMeshNodes(), millis());
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
nodeInfoMutex.lock();
|
||||
nodeInfoQueue.clear();
|
||||
// Replay states no-op for legacy clients / excluded DBs.
|
||||
state = STATE_REPLAY_POSITIONS;
|
||||
return getFromRadio(buf);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case STATE_REPLAY_POSITIONS: {
|
||||
if (replayPositionOrder.empty() && replayPositionIndex == 0)
|
||||
beginReplayPositions();
|
||||
prefetchReplayPositions();
|
||||
|
||||
meshtastic_MeshPacket pkt = {};
|
||||
bool havePkt = false;
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
if (!replayQueue.empty()) {
|
||||
pkt = replayQueue.front();
|
||||
replayQueue.pop_front();
|
||||
havePkt = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (havePkt) {
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = pkt;
|
||||
} else {
|
||||
LOG_DEBUG("Done replaying positions count=%u millis=%u", (unsigned)replayPositionIndex, millis());
|
||||
state = STATE_REPLAY_TELEMETRY;
|
||||
return getFromRadio(buf);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case STATE_REPLAY_TELEMETRY: {
|
||||
if (replayTelemetryOrder.empty() && replayTelemetryIndex == 0)
|
||||
beginReplayTelemetry();
|
||||
prefetchReplayTelemetry();
|
||||
|
||||
meshtastic_MeshPacket pkt = {};
|
||||
bool havePkt = false;
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
if (!replayQueue.empty()) {
|
||||
pkt = replayQueue.front();
|
||||
replayQueue.pop_front();
|
||||
havePkt = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (havePkt) {
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = pkt;
|
||||
} else {
|
||||
LOG_DEBUG("Done replaying telemetry count=%u millis=%u", (unsigned)replayTelemetryIndex, millis());
|
||||
state = STATE_REPLAY_ENVIRONMENT;
|
||||
return getFromRadio(buf);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case STATE_REPLAY_ENVIRONMENT: {
|
||||
if (replayEnvironmentOrder.empty() && replayEnvironmentIndex == 0)
|
||||
beginReplayEnvironment();
|
||||
prefetchReplayEnvironment();
|
||||
|
||||
meshtastic_MeshPacket pkt = {};
|
||||
bool havePkt = false;
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
if (!replayQueue.empty()) {
|
||||
pkt = replayQueue.front();
|
||||
replayQueue.pop_front();
|
||||
havePkt = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (havePkt) {
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = pkt;
|
||||
} else {
|
||||
LOG_DEBUG("Done replaying environment count=%u millis=%u", (unsigned)replayEnvironmentIndex, millis());
|
||||
state = STATE_REPLAY_STATUS;
|
||||
return getFromRadio(buf);
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
case STATE_REPLAY_STATUS: {
|
||||
if (replayStatusOrder.empty() && replayStatusIndex == 0)
|
||||
beginReplayStatus();
|
||||
prefetchReplayStatus();
|
||||
|
||||
meshtastic_MeshPacket pkt = {};
|
||||
bool havePkt = false;
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
if (!replayQueue.empty()) {
|
||||
pkt = replayQueue.front();
|
||||
replayQueue.pop_front();
|
||||
havePkt = true;
|
||||
}
|
||||
}
|
||||
|
||||
if (havePkt) {
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = pkt;
|
||||
} else {
|
||||
LOG_DEBUG("Done replaying status count=%u millis=%u", (unsigned)replayStatusIndex, millis());
|
||||
replayPositionOrder.clear();
|
||||
replayPositionOrder.shrink_to_fit();
|
||||
replayTelemetryOrder.clear();
|
||||
replayTelemetryOrder.shrink_to_fit();
|
||||
replayEnvironmentOrder.clear();
|
||||
replayEnvironmentOrder.shrink_to_fit();
|
||||
replayStatusOrder.clear();
|
||||
replayStatusOrder.shrink_to_fit();
|
||||
nodeInfoMutex.unlock();
|
||||
// Satellite-DB replay (positions/telemetry/environment/status) now happens
|
||||
// *after* config_complete_id, interleaved with live traffic in STATE_SEND_PACKETS.
|
||||
state = STATE_SEND_FILEMANIFEST;
|
||||
return getFromRadio(buf);
|
||||
}
|
||||
@@ -673,8 +555,7 @@ size_t PhoneAPI::getFromRadio(uint8_t *buf)
|
||||
case STATE_SEND_FILEMANIFEST: {
|
||||
LOG_DEBUG("FromRadio=STATE_SEND_FILEMANIFEST");
|
||||
// ONLY_NODES variants skip the manifest.
|
||||
if (config_state == filesManifest.size() || config_nonce == SPECIAL_NONCE_ONLY_NODES ||
|
||||
config_nonce == SPECIAL_NONCE_GRADIENT_ONLY_NODES) {
|
||||
if (config_state == filesManifest.size() || config_nonce == SPECIAL_NONCE_ONLY_NODES) {
|
||||
config_state = 0;
|
||||
filesManifest.clear();
|
||||
// Skip to complete packet
|
||||
@@ -719,6 +600,16 @@ size_t PhoneAPI::getFromRadio(uint8_t *buf)
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = *packetForPhone;
|
||||
releasePhonePacket();
|
||||
} else if (replayPending()) {
|
||||
// No live packet pending — feed the phone one cached satellite-DB packet.
|
||||
// popReplayPacket advances through positions->telemetry->environment->status,
|
||||
// and flips replayPhase back to IDLE when everything has been drained.
|
||||
meshtastic_MeshPacket replayPkt;
|
||||
if (popReplayPacket(replayPkt)) {
|
||||
printPacket("replay packet to phone", &replayPkt);
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_packet_tag;
|
||||
fromRadioScratch.packet = replayPkt;
|
||||
}
|
||||
}
|
||||
break;
|
||||
|
||||
@@ -743,10 +634,19 @@ size_t PhoneAPI::getFromRadio(uint8_t *buf)
|
||||
void PhoneAPI::sendConfigComplete()
|
||||
{
|
||||
LOG_INFO("Config Send Complete millis=%u", millis());
|
||||
const bool shouldReplaySatellites = (config_nonce != SPECIAL_NONCE_ONLY_CONFIG);
|
||||
// The phone sees config_complete_id first (treats sync as done), then the cached
|
||||
// satellite-DB packets (positions / telemetry / environment / status) trickle in
|
||||
// afterward as ordinary mesh packets (except SPECIAL_NONCE_ONLY_CONFIG, which
|
||||
// skips node/satellite sync entirely). Any client that handles live POSITION_APP /
|
||||
// TELEMETRY_APP / NODE_STATUS_APP packets handles these identically. STM32WL and
|
||||
// other builds that compile the satellite DBs out produce no replay packets and
|
||||
// the phase advances to IDLE in microseconds.
|
||||
fromRadioScratch.which_payload_variant = meshtastic_FromRadio_config_complete_id_tag;
|
||||
fromRadioScratch.config_complete_id = config_nonce;
|
||||
config_nonce = 0;
|
||||
state = STATE_SEND_PACKETS;
|
||||
replayPhase = shouldReplaySatellites ? REPLAY_PHASE_POSITIONS : REPLAY_PHASE_IDLE;
|
||||
if (api_type == TYPE_BLE) {
|
||||
service->api_state = service->STATE_BLE;
|
||||
} else if (api_type == TYPE_WIFI) {
|
||||
@@ -787,7 +687,8 @@ void PhoneAPI::prefetchNodeInfos()
|
||||
{
|
||||
bool added = false;
|
||||
bool wasEmpty = false;
|
||||
const bool gradient = clientWantsGradientSync();
|
||||
// Other-node NodeInfos always go out thin (no bundled position/device_metrics).
|
||||
// The post-config_complete_id replay drain delivers those as ordinary mesh packets.
|
||||
// Keep the queue topped up so BLE reads stay responsive even if DB fetches take a moment.
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
@@ -797,8 +698,7 @@ void PhoneAPI::prefetchNodeInfos()
|
||||
if (!nextNode)
|
||||
break;
|
||||
|
||||
auto info =
|
||||
gradient ? TypeConversions::ConvertToNodeInfoThin(nextNode) : TypeConversions::ConvertToNodeInfo(nextNode);
|
||||
auto info = TypeConversions::ConvertToNodeInfoThin(nextNode);
|
||||
bool isUs = info.num == nodeDB->getNodeNum();
|
||||
info.hops_away = isUs ? 0 : info.hops_away;
|
||||
info.last_heard = isUs ? getValidTime(RTCQualityFromNet) : info.last_heard;
|
||||
@@ -820,11 +720,20 @@ void PhoneAPI::prefetchNodeInfos()
|
||||
|
||||
meshtastic_MeshPacket PhoneAPI::makeReplayPositionPacket(NodeNum num, const meshtastic_PositionLite &pos)
|
||||
{
|
||||
// Shape this exactly like a fresh live broadcast Position from the peer so the
|
||||
// phone runs it through its normal "live position broadcast" handler path.
|
||||
// to=ourNum would read as a DM-from-peer and never lands in node detail UI.
|
||||
meshtastic_MeshPacket pkt = meshtastic_MeshPacket_init_default;
|
||||
pkt.from = num;
|
||||
pkt.to = nodeDB->getNodeNum();
|
||||
pkt.to = NODENUM_BROADCAST;
|
||||
pkt.id = generatePacketId();
|
||||
pkt.rx_time = pos.time;
|
||||
pkt.channel = 0;
|
||||
pkt.hop_limit = Default::getConfiguredOrDefaultHopLimit(config.lora.hop_limit);
|
||||
pkt.hop_start = pkt.hop_limit;
|
||||
pkt.priority = meshtastic_MeshPacket_Priority_BACKGROUND;
|
||||
// Mark as if heard over the air, not internally generated
|
||||
pkt.transport_mechanism = meshtastic_MeshPacket_TransportMechanism_TRANSPORT_LORA;
|
||||
pkt.which_payload_variant = meshtastic_MeshPacket_decoded_tag;
|
||||
pkt.decoded.portnum = meshtastic_PortNum_POSITION_APP;
|
||||
meshtastic_Position fullPos = TypeConversions::ConvertToPosition(pos);
|
||||
@@ -838,11 +747,18 @@ meshtastic_MeshPacket PhoneAPI::makeReplayTelemetryPacket(NodeNum num, const mes
|
||||
{
|
||||
meshtastic_MeshPacket pkt = meshtastic_MeshPacket_init_default;
|
||||
pkt.from = num;
|
||||
pkt.to = nodeDB->getNodeNum();
|
||||
pkt.to = NODENUM_BROADCAST;
|
||||
pkt.id = generatePacketId();
|
||||
// No native timestamp on telemetry packets here; use last_heard.
|
||||
const meshtastic_NodeInfoLite *header = nodeDB->getMeshNode(num);
|
||||
pkt.rx_time = header ? header->last_heard : 0;
|
||||
pkt.channel = 0;
|
||||
pkt.hop_limit = Default::getConfiguredOrDefaultHopLimit(config.lora.hop_limit);
|
||||
pkt.hop_start = pkt.hop_limit;
|
||||
pkt.priority = meshtastic_MeshPacket_Priority_BACKGROUND;
|
||||
// Mark as if heard over the air, not internally generated — iOS client filters
|
||||
// TRANSPORT_INTERNAL packets out of broadcast peer state updates.
|
||||
pkt.transport_mechanism = meshtastic_MeshPacket_TransportMechanism_TRANSPORT_LORA;
|
||||
pkt.which_payload_variant = meshtastic_MeshPacket_decoded_tag;
|
||||
pkt.decoded.portnum = meshtastic_PortNum_TELEMETRY_APP;
|
||||
meshtastic_Telemetry fullTel = meshtastic_Telemetry_init_default;
|
||||
@@ -858,16 +774,12 @@ meshtastic_MeshPacket PhoneAPI::makeReplayTelemetryPacket(NodeNum num, const mes
|
||||
void PhoneAPI::beginReplayPositions()
|
||||
{
|
||||
#if MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
// Build excluded entirely - leave the order list empty so the state arm
|
||||
// Build excluded entirely - leave the order list empty so the phase
|
||||
// immediately drains and advances.
|
||||
replayPositionOrder.clear();
|
||||
replayPositionIndex = 0;
|
||||
#else
|
||||
if (!clientWantsGradientSync()) {
|
||||
replayPositionOrder.clear();
|
||||
replayPositionIndex = 0;
|
||||
return;
|
||||
}
|
||||
// Caller (popReplayPacket) only invokes us when replayPhase is armed.
|
||||
// Snapshot the keyset at phase start so concurrent inserts/erases on the
|
||||
// map don't invalidate iteration. Skip our own node - the phone already
|
||||
// got our position bundled in STATE_SEND_OWN_NODEINFO.
|
||||
@@ -882,8 +794,6 @@ void PhoneAPI::prefetchReplayPositions()
|
||||
#if MESHTASTIC_EXCLUDE_POSITIONDB
|
||||
return;
|
||||
#else
|
||||
if (!clientWantsGradientSync())
|
||||
return;
|
||||
bool added = false;
|
||||
bool wasEmpty = false;
|
||||
{
|
||||
@@ -909,11 +819,6 @@ void PhoneAPI::beginReplayTelemetry()
|
||||
replayTelemetryOrder.clear();
|
||||
replayTelemetryIndex = 0;
|
||||
#else
|
||||
if (!clientWantsGradientSync()) {
|
||||
replayTelemetryOrder.clear();
|
||||
replayTelemetryIndex = 0;
|
||||
return;
|
||||
}
|
||||
replayTelemetryOrder = nodeDB->snapshotTelemetryNodeNums(nodeDB->getNodeNum());
|
||||
replayTelemetryIndex = 0;
|
||||
LOG_INFO("Begin telemetry replay: %u entries millis=%u", (unsigned)replayTelemetryOrder.size(), millis());
|
||||
@@ -925,8 +830,6 @@ void PhoneAPI::prefetchReplayTelemetry()
|
||||
#if MESHTASTIC_EXCLUDE_TELEMETRYDB
|
||||
return;
|
||||
#else
|
||||
if (!clientWantsGradientSync())
|
||||
return;
|
||||
bool added = false;
|
||||
bool wasEmpty = false;
|
||||
{
|
||||
@@ -950,10 +853,17 @@ meshtastic_MeshPacket PhoneAPI::makeReplayEnvironmentPacket(uint32_t num, const
|
||||
{
|
||||
meshtastic_MeshPacket pkt = meshtastic_MeshPacket_init_default;
|
||||
pkt.from = num;
|
||||
pkt.to = nodeDB->getNodeNum();
|
||||
pkt.to = NODENUM_BROADCAST;
|
||||
pkt.id = generatePacketId();
|
||||
const meshtastic_NodeInfoLite *header = nodeDB->getMeshNode(num);
|
||||
pkt.rx_time = header ? header->last_heard : 0;
|
||||
pkt.channel = 0;
|
||||
pkt.hop_limit = Default::getConfiguredOrDefaultHopLimit(config.lora.hop_limit);
|
||||
pkt.hop_start = pkt.hop_limit;
|
||||
pkt.priority = meshtastic_MeshPacket_Priority_BACKGROUND;
|
||||
// Mark as if heard over the air, not internally generated — iOS client filters
|
||||
// TRANSPORT_INTERNAL packets out of broadcast peer state updates.
|
||||
pkt.transport_mechanism = meshtastic_MeshPacket_TransportMechanism_TRANSPORT_LORA;
|
||||
pkt.which_payload_variant = meshtastic_MeshPacket_decoded_tag;
|
||||
pkt.decoded.portnum = meshtastic_PortNum_TELEMETRY_APP;
|
||||
meshtastic_Telemetry fullTel = meshtastic_Telemetry_init_default;
|
||||
@@ -972,11 +882,6 @@ void PhoneAPI::beginReplayEnvironment()
|
||||
replayEnvironmentOrder.clear();
|
||||
replayEnvironmentIndex = 0;
|
||||
#else
|
||||
if (!clientWantsGradientSync()) {
|
||||
replayEnvironmentOrder.clear();
|
||||
replayEnvironmentIndex = 0;
|
||||
return;
|
||||
}
|
||||
replayEnvironmentOrder = nodeDB->snapshotEnvironmentNodeNums(nodeDB->getNodeNum());
|
||||
replayEnvironmentIndex = 0;
|
||||
LOG_INFO("Begin environment replay: %u entries millis=%u", (unsigned)replayEnvironmentOrder.size(), millis());
|
||||
@@ -988,8 +893,6 @@ void PhoneAPI::prefetchReplayEnvironment()
|
||||
#if MESHTASTIC_EXCLUDE_ENVIRONMENTDB
|
||||
return;
|
||||
#else
|
||||
if (!clientWantsGradientSync())
|
||||
return;
|
||||
bool added = false;
|
||||
bool wasEmpty = false;
|
||||
{
|
||||
@@ -1013,11 +916,17 @@ meshtastic_MeshPacket PhoneAPI::makeReplayStatusPacket(uint32_t num, const mesht
|
||||
{
|
||||
meshtastic_MeshPacket pkt = meshtastic_MeshPacket_init_default;
|
||||
pkt.from = num;
|
||||
pkt.to = nodeDB->getNodeNum();
|
||||
pkt.to = NODENUM_BROADCAST;
|
||||
pkt.id = generatePacketId();
|
||||
// StatusMessage has no native timestamp; use last_heard.
|
||||
const meshtastic_NodeInfoLite *header = nodeDB->getMeshNode(num);
|
||||
pkt.rx_time = header ? header->last_heard : 0;
|
||||
pkt.channel = 0;
|
||||
pkt.hop_limit = Default::getConfiguredOrDefaultHopLimit(config.lora.hop_limit);
|
||||
pkt.hop_start = pkt.hop_limit;
|
||||
pkt.priority = meshtastic_MeshPacket_Priority_BACKGROUND;
|
||||
// Mark as if heard over the air, not internally generated — client filters
|
||||
pkt.transport_mechanism = meshtastic_MeshPacket_TransportMechanism_TRANSPORT_LORA;
|
||||
pkt.which_payload_variant = meshtastic_MeshPacket_decoded_tag;
|
||||
pkt.decoded.portnum = meshtastic_PortNum_NODE_STATUS_APP;
|
||||
size_t len =
|
||||
@@ -1032,11 +941,6 @@ void PhoneAPI::beginReplayStatus()
|
||||
replayStatusOrder.clear();
|
||||
replayStatusIndex = 0;
|
||||
#else
|
||||
if (!clientWantsGradientSync()) {
|
||||
replayStatusOrder.clear();
|
||||
replayStatusIndex = 0;
|
||||
return;
|
||||
}
|
||||
replayStatusOrder = nodeDB->snapshotStatusNodeNums(nodeDB->getNodeNum());
|
||||
replayStatusIndex = 0;
|
||||
LOG_INFO("Begin status replay: %u entries millis=%u", (unsigned)replayStatusOrder.size(), millis());
|
||||
@@ -1048,8 +952,6 @@ void PhoneAPI::prefetchReplayStatus()
|
||||
#if MESHTASTIC_EXCLUDE_STATUSDB
|
||||
return;
|
||||
#else
|
||||
if (!clientWantsGradientSync())
|
||||
return;
|
||||
bool added = false;
|
||||
bool wasEmpty = false;
|
||||
{
|
||||
@@ -1069,6 +971,94 @@ void PhoneAPI::prefetchReplayStatus()
|
||||
#endif
|
||||
}
|
||||
|
||||
// Pop one cached satellite-DB packet from the active replay phase.
|
||||
// Phases drain in order: positions -> telemetry -> environment -> status.
|
||||
// When the current phase's cursor is exhausted (queue empty AND no more entries
|
||||
// to snapshot), advance to the next phase. When all four phases are done,
|
||||
// flip replayPhase back to IDLE and release the snapshot vectors.
|
||||
//
|
||||
// Returns true if a packet was placed in `out`; false if everything is drained.
|
||||
bool PhoneAPI::popReplayPacket(meshtastic_MeshPacket &out)
|
||||
{
|
||||
while (replayPhase != REPLAY_PHASE_IDLE) {
|
||||
// Prime the active phase: seed the snapshot vector on first entry,
|
||||
// top up replayQueue from the snapshot up to kReplayPrefetchDepth.
|
||||
switch (replayPhase) {
|
||||
case REPLAY_PHASE_POSITIONS:
|
||||
if (replayPositionOrder.empty() && replayPositionIndex == 0)
|
||||
beginReplayPositions();
|
||||
prefetchReplayPositions();
|
||||
break;
|
||||
case REPLAY_PHASE_TELEMETRY:
|
||||
if (replayTelemetryOrder.empty() && replayTelemetryIndex == 0)
|
||||
beginReplayTelemetry();
|
||||
prefetchReplayTelemetry();
|
||||
break;
|
||||
case REPLAY_PHASE_ENVIRONMENT:
|
||||
if (replayEnvironmentOrder.empty() && replayEnvironmentIndex == 0)
|
||||
beginReplayEnvironment();
|
||||
prefetchReplayEnvironment();
|
||||
break;
|
||||
case REPLAY_PHASE_STATUS:
|
||||
if (replayStatusOrder.empty() && replayStatusIndex == 0)
|
||||
beginReplayStatus();
|
||||
prefetchReplayStatus();
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
{
|
||||
concurrency::LockGuard guard(&nodeInfoMutex);
|
||||
if (!replayQueue.empty()) {
|
||||
out = replayQueue.front();
|
||||
replayQueue.pop_front();
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
// Queue empty AND no more entries to feed it — phase is exhausted.
|
||||
advanceReplayPhase();
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
void PhoneAPI::advanceReplayPhase()
|
||||
{
|
||||
switch (replayPhase) {
|
||||
case REPLAY_PHASE_POSITIONS:
|
||||
LOG_DEBUG("Replay drain: positions done (count=%u) millis=%u", (unsigned)replayPositionIndex, millis());
|
||||
replayPhase = REPLAY_PHASE_TELEMETRY;
|
||||
break;
|
||||
case REPLAY_PHASE_TELEMETRY:
|
||||
LOG_DEBUG("Replay drain: telemetry done (count=%u) millis=%u", (unsigned)replayTelemetryIndex, millis());
|
||||
replayPhase = REPLAY_PHASE_ENVIRONMENT;
|
||||
break;
|
||||
case REPLAY_PHASE_ENVIRONMENT:
|
||||
LOG_DEBUG("Replay drain: environment done (count=%u) millis=%u", (unsigned)replayEnvironmentIndex, millis());
|
||||
replayPhase = REPLAY_PHASE_STATUS;
|
||||
break;
|
||||
case REPLAY_PHASE_STATUS:
|
||||
LOG_INFO("Replay drain complete (status count=%u) millis=%u", (unsigned)replayStatusIndex, millis());
|
||||
replayPositionOrder.clear();
|
||||
replayPositionOrder.shrink_to_fit();
|
||||
replayTelemetryOrder.clear();
|
||||
replayTelemetryOrder.shrink_to_fit();
|
||||
replayEnvironmentOrder.clear();
|
||||
replayEnvironmentOrder.shrink_to_fit();
|
||||
replayStatusOrder.clear();
|
||||
replayStatusOrder.shrink_to_fit();
|
||||
replayPositionIndex = 0;
|
||||
replayTelemetryIndex = 0;
|
||||
replayEnvironmentIndex = 0;
|
||||
replayStatusIndex = 0;
|
||||
replayPhase = REPLAY_PHASE_IDLE;
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
void PhoneAPI::releaseMqttClientProxyPhonePacket()
|
||||
{
|
||||
if (mqttClientProxyMessageForPhone) {
|
||||
@@ -1115,31 +1105,6 @@ bool PhoneAPI::available()
|
||||
PREFETCH_NODEINFO:
|
||||
prefetchNodeInfos();
|
||||
return true;
|
||||
case STATE_REPLAY_POSITIONS: {
|
||||
// Prime the iterator if we haven't yet, then top up the queue.
|
||||
if (replayPositionOrder.empty() && replayPositionIndex == 0)
|
||||
beginReplayPositions();
|
||||
prefetchReplayPositions();
|
||||
return true; // Always advance state machine; arm itself transitions when drained
|
||||
}
|
||||
case STATE_REPLAY_TELEMETRY: {
|
||||
if (replayTelemetryOrder.empty() && replayTelemetryIndex == 0)
|
||||
beginReplayTelemetry();
|
||||
prefetchReplayTelemetry();
|
||||
return true;
|
||||
}
|
||||
case STATE_REPLAY_ENVIRONMENT: {
|
||||
if (replayEnvironmentOrder.empty() && replayEnvironmentIndex == 0)
|
||||
beginReplayEnvironment();
|
||||
prefetchReplayEnvironment();
|
||||
return true;
|
||||
}
|
||||
case STATE_REPLAY_STATUS: {
|
||||
if (replayStatusOrder.empty() && replayStatusIndex == 0)
|
||||
beginReplayStatus();
|
||||
prefetchReplayStatus();
|
||||
return true;
|
||||
}
|
||||
case STATE_SEND_PACKETS: {
|
||||
if (!queueStatusPacketForPhone)
|
||||
queueStatusPacketForPhone = service->getQueueStatusForPhone();
|
||||
@@ -1171,7 +1136,11 @@ bool PhoneAPI::available()
|
||||
if (!packetForPhone)
|
||||
packetForPhone = service->getForPhone();
|
||||
hasPacket = !!packetForPhone;
|
||||
return hasPacket;
|
||||
if (hasPacket)
|
||||
return true;
|
||||
// Trailing replay drain — feeds cached satellite-DB packets alongside
|
||||
// (lower priority than) live traffic.
|
||||
return replayPending();
|
||||
}
|
||||
default:
|
||||
LOG_ERROR("PhoneAPI::available unexpected state %d", state);
|
||||
|
||||
+22
-15
@@ -26,9 +26,6 @@
|
||||
|
||||
#define SPECIAL_NONCE_ONLY_CONFIG 69420
|
||||
#define SPECIAL_NONCE_ONLY_NODES 69421 // ( ͡° ͜ʖ ͡°)
|
||||
// Gradient sync: phone sends one of these to opt into thin-header + replay.
|
||||
#define SPECIAL_NONCE_GRADIENT_SYNC 69422
|
||||
#define SPECIAL_NONCE_GRADIENT_ONLY_NODES 69423
|
||||
|
||||
/**
|
||||
* Provides our protobuf based API which phone/PC clients can use to talk to our device
|
||||
@@ -52,15 +49,22 @@ class PhoneAPI
|
||||
STATE_SEND_CONFIG, // Replacement for the old Radioconfig
|
||||
STATE_SEND_MODULECONFIG, // Send Module specific config
|
||||
STATE_SEND_OTHER_NODEINFOS, // states progress in this order as the device sends to to the client
|
||||
// Drain satellite DBs as synthetic POSITION_APP / TELEMETRY_APP /
|
||||
// NODE_STATUS_APP packets when the phone opted into gradient sync.
|
||||
STATE_REPLAY_POSITIONS,
|
||||
STATE_REPLAY_TELEMETRY,
|
||||
STATE_REPLAY_ENVIRONMENT,
|
||||
STATE_REPLAY_STATUS,
|
||||
STATE_SEND_FILEMANIFEST, // Send file manifest
|
||||
STATE_SEND_FILEMANIFEST, // Send file manifest
|
||||
STATE_SEND_COMPLETE_ID,
|
||||
STATE_SEND_PACKETS // send packets or debug strings
|
||||
STATE_SEND_PACKETS // live mesh packets + any cached satellite-DB replay that trails sync completion
|
||||
};
|
||||
|
||||
// Satellite-DB replay (positions / telemetry / environment / status) used to live
|
||||
// as four top-level states between STATE_SEND_OTHER_NODEINFOS and STATE_SEND_FILEMANIFEST.
|
||||
// It now drains *after* config_complete_id has been emitted: the phone considers the
|
||||
// initial sync done as soon as headers + manifest are delivered, and the cached
|
||||
// position/telemetry/etc. trickle in alongside live mesh traffic inside STATE_SEND_PACKETS.
|
||||
enum ReplayPhase : uint8_t {
|
||||
REPLAY_PHASE_IDLE = 0, // not replaying (legacy clients, no-op DBs, or replay finished)
|
||||
REPLAY_PHASE_POSITIONS,
|
||||
REPLAY_PHASE_TELEMETRY,
|
||||
REPLAY_PHASE_ENVIRONMENT,
|
||||
REPLAY_PHASE_STATUS,
|
||||
};
|
||||
|
||||
State state = STATE_SEND_NOTHING;
|
||||
@@ -114,6 +118,7 @@ class PhoneAPI
|
||||
size_t replayTelemetryIndex = 0;
|
||||
size_t replayEnvironmentIndex = 0;
|
||||
size_t replayStatusIndex = 0;
|
||||
ReplayPhase replayPhase = REPLAY_PHASE_IDLE; // armed by sendConfigComplete() for full/default sync
|
||||
|
||||
meshtastic_ToRadio toRadioScratch = {
|
||||
0}; // this is a static scratch object, any data must be copied elsewhere before returning
|
||||
@@ -164,10 +169,6 @@ class PhoneAPI
|
||||
|
||||
bool isConnected() { return state != STATE_SEND_NOTHING; }
|
||||
bool isSendingPackets() { return state == STATE_SEND_PACKETS; }
|
||||
bool clientWantsGradientSync() const
|
||||
{
|
||||
return config_nonce == SPECIAL_NONCE_GRADIENT_SYNC || config_nonce == SPECIAL_NONCE_GRADIENT_ONLY_NODES;
|
||||
}
|
||||
|
||||
protected:
|
||||
/// Our fromradio packet while it is being assembled
|
||||
@@ -229,6 +230,12 @@ class PhoneAPI
|
||||
meshtastic_MeshPacket makeReplayEnvironmentPacket(uint32_t num, const meshtastic_EnvironmentMetrics &env);
|
||||
meshtastic_MeshPacket makeReplayStatusPacket(uint32_t num, const meshtastic_StatusMessage &status);
|
||||
|
||||
// Post-sync replay drain: pop one cached packet from the active phase, advancing
|
||||
// through positions -> telemetry -> environment -> status until everything is drained.
|
||||
bool popReplayPacket(meshtastic_MeshPacket &out);
|
||||
void advanceReplayPhase();
|
||||
bool replayPending() const { return replayPhase != REPLAY_PHASE_IDLE; }
|
||||
|
||||
void releaseMqttClientProxyPhonePacket();
|
||||
|
||||
void releaseClientNotification();
|
||||
|
||||
@@ -0,0 +1,75 @@
|
||||
#include "PositionPrecision.h"
|
||||
#include "Channels.h"
|
||||
#include "mesh-pb-constants.h"
|
||||
|
||||
#include <Arduino.h>
|
||||
|
||||
uint32_t getPositionPrecisionForChannel(uint8_t channelIndex)
|
||||
{
|
||||
const meshtastic_Channel &channel = channels.getByIndex(channelIndex);
|
||||
|
||||
if (channel.settings.has_module_settings) {
|
||||
return channel.settings.module_settings.position_precision;
|
||||
} else if (channel.role == meshtastic_Channel_Role_PRIMARY) {
|
||||
return 32;
|
||||
} else {
|
||||
return 0;
|
||||
}
|
||||
}
|
||||
|
||||
static int32_t truncateCoordinate(int32_t coordinate, uint32_t precision)
|
||||
{
|
||||
uint32_t coordinateBits = static_cast<uint32_t>(coordinate);
|
||||
uint32_t truncated = coordinateBits & (UINT32_MAX << (32 - precision));
|
||||
|
||||
// Use the middle of the possible location, not the low edge of the bucket.
|
||||
truncated += (1UL << (31 - precision));
|
||||
|
||||
return static_cast<int32_t>(truncated);
|
||||
}
|
||||
|
||||
void applyPositionPrecision(meshtastic_Position &position, uint32_t precision)
|
||||
{
|
||||
if (precision == 0) {
|
||||
uint32_t time = position.time;
|
||||
position = meshtastic_Position_init_default;
|
||||
position.time = time;
|
||||
return;
|
||||
}
|
||||
|
||||
uint32_t effectivePrecision = precision > 32 ? 32 : precision;
|
||||
position.precision_bits = effectivePrecision;
|
||||
|
||||
if (effectivePrecision < 32) {
|
||||
position.latitude_i = truncateCoordinate(position.latitude_i, effectivePrecision);
|
||||
position.longitude_i = truncateCoordinate(position.longitude_i, effectivePrecision);
|
||||
}
|
||||
}
|
||||
|
||||
bool applyPositionPrecision(meshtastic_MeshPacket &packet, uint32_t precision)
|
||||
{
|
||||
if (packet.which_payload_variant != meshtastic_MeshPacket_decoded_tag ||
|
||||
packet.decoded.portnum != meshtastic_PortNum_POSITION_APP) {
|
||||
return true;
|
||||
}
|
||||
|
||||
meshtastic_Position position = meshtastic_Position_init_default;
|
||||
if (!pb_decode_from_bytes(packet.decoded.payload.bytes, packet.decoded.payload.size, &meshtastic_Position_msg, &position)) {
|
||||
return false;
|
||||
}
|
||||
|
||||
applyPositionPrecision(position, precision);
|
||||
packet.decoded.payload.size = pb_encode_to_bytes(packet.decoded.payload.bytes, sizeof(packet.decoded.payload.bytes),
|
||||
&meshtastic_Position_msg, &position);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool applyPositionPrecisionForChannel(meshtastic_MeshPacket &packet, uint8_t channelIndex)
|
||||
{
|
||||
if (packet.which_payload_variant != meshtastic_MeshPacket_decoded_tag ||
|
||||
packet.decoded.portnum != meshtastic_PortNum_POSITION_APP) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return applyPositionPrecision(packet, getPositionPrecisionForChannel(channelIndex));
|
||||
}
|
||||
@@ -0,0 +1,9 @@
|
||||
#pragma once
|
||||
|
||||
#include "meshtastic/mesh.pb.h"
|
||||
#include <stdint.h>
|
||||
|
||||
uint32_t getPositionPrecisionForChannel(uint8_t channelIndex);
|
||||
void applyPositionPrecision(meshtastic_Position &position, uint32_t precision);
|
||||
bool applyPositionPrecision(meshtastic_MeshPacket &packet, uint32_t precision);
|
||||
bool applyPositionPrecisionForChannel(meshtastic_MeshPacket &packet, uint8_t channelIndex);
|
||||
@@ -34,6 +34,10 @@
|
||||
#include "STM32WLE5JCInterface.h"
|
||||
#endif
|
||||
|
||||
#ifdef USE_HALOW_RADIO
|
||||
#include "halow/HaLowInterface.h"
|
||||
#endif
|
||||
|
||||
static const meshtastic_Config_LoRaConfig_ModemPreset PRESETS_STD[] = {
|
||||
meshtastic_Config_LoRaConfig_ModemPreset_LONG_FAST, meshtastic_Config_LoRaConfig_ModemPreset_LONG_SLOW,
|
||||
meshtastic_Config_LoRaConfig_ModemPreset_MEDIUM_SLOW, meshtastic_Config_LoRaConfig_ModemPreset_MEDIUM_FAST,
|
||||
@@ -520,6 +524,22 @@ std::unique_ptr<RadioInterface> initLoRa()
|
||||
rebootAtMsec = millis() + 5000;
|
||||
}
|
||||
}
|
||||
|
||||
#ifdef USE_HALOW_RADIO
|
||||
// HaLow is the only radio on the dedicated XIAO+HaLow variant, so we only
|
||||
// try it when no LoRa chip claimed the slot. The interface itself stubs
|
||||
// out cleanly when USE_MM_IOT_ESP32 is not yet wired in (Phase 0 of plan).
|
||||
if (!rIf) {
|
||||
auto halowIf = std::unique_ptr<HaLowInterface>(new HaLowInterface());
|
||||
if (!halowIf->init()) {
|
||||
LOG_WARN("HaLow init failed (stub or SDK not present)");
|
||||
} else {
|
||||
LOG_INFO("HaLow init success");
|
||||
rIf = std::move(halowIf);
|
||||
}
|
||||
}
|
||||
#endif
|
||||
|
||||
return rIf;
|
||||
}
|
||||
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include "MeshRadio.h"
|
||||
#include "MeshService.h"
|
||||
#include "NodeDB.h"
|
||||
#include "PositionPrecision.h"
|
||||
#include "RTC.h"
|
||||
|
||||
#include "configuration.h"
|
||||
@@ -367,6 +368,11 @@ ErrorCode Router::send(meshtastic_MeshPacket *p)
|
||||
}
|
||||
|
||||
fixPriority(p); // Before encryption, fix the priority if it's unset
|
||||
if (!applyPositionPrecisionForChannel(*p, p->channel)) {
|
||||
LOG_ERROR("Dropping malformed position packet before send");
|
||||
packetPool.release(p);
|
||||
return meshtastic_Routing_Error_BAD_REQUEST;
|
||||
}
|
||||
|
||||
// If the packet is not yet encrypted, do so now
|
||||
if (p->which_payload_variant == meshtastic_MeshPacket_decoded_tag) {
|
||||
|
||||
@@ -37,6 +37,7 @@ meshtastic_NodeInfo TypeConversions::ConvertToNodeInfo(const meshtastic_NodeInfo
|
||||
info.position.altitude = position->altitude;
|
||||
info.position.location_source = position->location_source;
|
||||
info.position.time = position->time;
|
||||
info.position.precision_bits = position->precision_bits;
|
||||
}
|
||||
if (nodeInfoLiteHasUser(lite)) {
|
||||
info.has_user = true;
|
||||
@@ -71,6 +72,7 @@ meshtastic_PositionLite TypeConversions::ConvertToPositionLite(meshtastic_Positi
|
||||
lite.altitude = position.altitude;
|
||||
lite.location_source = position.location_source;
|
||||
lite.time = position.time;
|
||||
lite.precision_bits = position.precision_bits;
|
||||
|
||||
return lite;
|
||||
}
|
||||
@@ -89,6 +91,11 @@ meshtastic_Position TypeConversions::ConvertToPosition(meshtastic_PositionLite l
|
||||
position.altitude = lite.altitude;
|
||||
position.location_source = lite.location_source;
|
||||
position.time = lite.time;
|
||||
// Preserve the peer's broadcast precision; falls back to 0 for entries cached
|
||||
// before the precision_bits field existed in PositionLite (pre-migration data).
|
||||
// iOS treats 0 as "unspecified precision" and won't render the pin — so for
|
||||
// unset values, declare full precision so the stored lat/lon renders as a point.
|
||||
position.precision_bits = lite.precision_bits == 0 ? 32 : lite.precision_bits;
|
||||
|
||||
return position;
|
||||
}
|
||||
|
||||
@@ -15,6 +15,9 @@ PB_BIND(meshtastic_AdminMessage_InputEvent, meshtastic_AdminMessage_InputEvent,
|
||||
PB_BIND(meshtastic_AdminMessage_OTAEvent, meshtastic_AdminMessage_OTAEvent, AUTO)
|
||||
|
||||
|
||||
PB_BIND(meshtastic_LockdownAuth, meshtastic_LockdownAuth, AUTO)
|
||||
|
||||
|
||||
PB_BIND(meshtastic_HamParameters, meshtastic_HamParameters, AUTO)
|
||||
|
||||
|
||||
|
||||
@@ -130,6 +130,76 @@ typedef struct _meshtastic_AdminMessage_OTAEvent {
|
||||
meshtastic_AdminMessage_OTAEvent_ota_hash_t ota_hash;
|
||||
} meshtastic_AdminMessage_OTAEvent;
|
||||
|
||||
typedef PB_BYTES_ARRAY_T(32) meshtastic_LockdownAuth_passphrase_t;
|
||||
/* Lockdown passphrase delivery payload.
|
||||
|
||||
One message handles three operations distinguished by content:
|
||||
- Provision (first-time): passphrase set, lock_now=false. Firmware
|
||||
generates DEK, wraps with passphrase-derived KEK, persists.
|
||||
- Unlock: passphrase set, lock_now=false. Firmware verifies
|
||||
passphrase against stored DEK, unlocks storage, authorizes the
|
||||
connection that delivered this packet.
|
||||
- Lock now: lock_now=true, passphrase ignored. Firmware revokes
|
||||
all client auth and reboots into the locked state.
|
||||
|
||||
Firmware decides between provision and unlock based on its own state
|
||||
(whether a DEK file already exists). Clients do not need to track
|
||||
which case applies. */
|
||||
typedef struct _meshtastic_LockdownAuth {
|
||||
/* Passphrase bytes (1-32). Empty when lock_now is true.
|
||||
Capped to 32 to match the proto cap on related security fields. */
|
||||
meshtastic_LockdownAuth_passphrase_t passphrase;
|
||||
/* Optional override of the boot-count token TTL granted on success.
|
||||
0 = use firmware default (TOKEN_DEFAULT_BOOTS).
|
||||
On reboot the firmware decrements this; when it reaches 0 the
|
||||
device boots fully locked and requires a fresh passphrase. */
|
||||
uint32_t boots_remaining;
|
||||
/* Optional wall-clock expiry for the unlock token, as absolute
|
||||
Unix-epoch seconds. 0 = no time limit (only the boot-count TTL
|
||||
applies). On boot, if the device RTC is set and now > this value,
|
||||
the token is treated as expired. */
|
||||
uint32_t valid_until_epoch;
|
||||
/* If true, ignore passphrase fields, immediately revoke all
|
||||
connection-level admin authorization, and reboot the device into
|
||||
the locked state. Always honoured regardless of current lock state. */
|
||||
bool lock_now;
|
||||
/* Optional per-boot uptime cap on the unlocked session, in seconds.
|
||||
0 = unlimited (token-only enforcement, suitable for unattended
|
||||
tower / infrastructure nodes).
|
||||
|
||||
When non-zero, the firmware arms an uptime timer at unlock. On
|
||||
each expiry, while there is still boot-count budget, the firmware
|
||||
decrements the on-flash boot count in place, revokes per-
|
||||
connection admin auth (clients must re-authenticate to see
|
||||
content), re-engages the screen lock, and re-arms the timer
|
||||
without rebooting. Mesh routing keeps running across session
|
||||
boundaries; only when the boot-count budget reaches zero does
|
||||
the device hard-lock and reboot.
|
||||
|
||||
Total exposure ceiling = ((resolved boot count) + 1) * max_session_seconds.
|
||||
The +1 accounts for the initial passphrase-unlocked session
|
||||
itself, since boots_remaining is the number of subsequent
|
||||
session rolls (each consuming one boot from the rollback ledger).
|
||||
The resolved boot count is the value the firmware writes into the
|
||||
token at unlock time: the client-supplied boots_remaining when
|
||||
non-zero, otherwise the firmware default (TOKEN_DEFAULT_BOOTS).
|
||||
Note that boots_remaining == 0 in this message means "use firmware
|
||||
default", NOT "zero boots" — a client computing the ceiling for
|
||||
display should mirror that resolution rather than multiplying the
|
||||
raw request value.
|
||||
|
||||
The cap is persisted in the token, so it survives token-based
|
||||
auto-unlock across reboots. Explicit operator Lock Now still
|
||||
deletes the token and forces passphrase re-entry.
|
||||
|
||||
Uses millis() (CPU uptime), not wall-clock time, so the cap is
|
||||
immune to GPS spoofing, RTC backup-battery removal, and Faraday
|
||||
cage isolation — none of those move the uptime counter. The only
|
||||
way to reset the session clock is a reboot, which costs a boot
|
||||
from the on-flash, HMAC-bound counter. */
|
||||
uint32_t max_session_seconds;
|
||||
} meshtastic_LockdownAuth;
|
||||
|
||||
/* Parameters for setting up Meshtastic for ameteur radio usage */
|
||||
typedef struct _meshtastic_HamParameters {
|
||||
/* Amateur radio call sign, eg. KD2ABC */
|
||||
@@ -384,6 +454,15 @@ typedef struct _meshtastic_AdminMessage {
|
||||
meshtastic_AdminMessage_OTAEvent ota_request;
|
||||
/* Parameters and sensor configuration */
|
||||
meshtastic_SensorConfig sensor_config;
|
||||
/* Lockdown passphrase delivery / unlock / lock-now command for hardened
|
||||
firmware builds (see MESHTASTIC_LOCKDOWN). Used to provision the
|
||||
passphrase on first boot, unlock encrypted storage on subsequent
|
||||
reboots, re-verify on already-unlocked devices to authorize a new
|
||||
client connection, or immediately re-lock the device.
|
||||
|
||||
Replaces the earlier scheme that repurposed SecurityConfig.private_key
|
||||
to carry passphrase bytes; that hack is retired. */
|
||||
meshtastic_LockdownAuth lockdown_auth;
|
||||
};
|
||||
/* The node generates this key and sends it with any get_x_response packets.
|
||||
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
|
||||
@@ -429,6 +508,7 @@ extern "C" {
|
||||
|
||||
|
||||
|
||||
|
||||
#define meshtastic_KeyVerificationAdmin_message_type_ENUMTYPE meshtastic_KeyVerificationAdmin_MessageType
|
||||
|
||||
|
||||
@@ -441,6 +521,7 @@ extern "C" {
|
||||
#define meshtastic_AdminMessage_init_default {0, {0}, {0, {0}}}
|
||||
#define meshtastic_AdminMessage_InputEvent_init_default {0, 0, 0, 0}
|
||||
#define meshtastic_AdminMessage_OTAEvent_init_default {_meshtastic_OTAMode_MIN, {0, {0}}}
|
||||
#define meshtastic_LockdownAuth_init_default {{0, {0}}, 0, 0, 0, 0}
|
||||
#define meshtastic_HamParameters_init_default {"", 0, 0, ""}
|
||||
#define meshtastic_NodeRemoteHardwarePinsResponse_init_default {0, {meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default}}
|
||||
#define meshtastic_SharedContact_init_default {0, false, meshtastic_User_init_default, 0, 0}
|
||||
@@ -453,6 +534,7 @@ extern "C" {
|
||||
#define meshtastic_AdminMessage_init_zero {0, {0}, {0, {0}}}
|
||||
#define meshtastic_AdminMessage_InputEvent_init_zero {0, 0, 0, 0}
|
||||
#define meshtastic_AdminMessage_OTAEvent_init_zero {_meshtastic_OTAMode_MIN, {0, {0}}}
|
||||
#define meshtastic_LockdownAuth_init_zero {{0, {0}}, 0, 0, 0, 0}
|
||||
#define meshtastic_HamParameters_init_zero {"", 0, 0, ""}
|
||||
#define meshtastic_NodeRemoteHardwarePinsResponse_init_zero {0, {meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero}}
|
||||
#define meshtastic_SharedContact_init_zero {0, false, meshtastic_User_init_zero, 0, 0}
|
||||
@@ -470,6 +552,11 @@ extern "C" {
|
||||
#define meshtastic_AdminMessage_InputEvent_touch_y_tag 4
|
||||
#define meshtastic_AdminMessage_OTAEvent_reboot_ota_mode_tag 1
|
||||
#define meshtastic_AdminMessage_OTAEvent_ota_hash_tag 2
|
||||
#define meshtastic_LockdownAuth_passphrase_tag 1
|
||||
#define meshtastic_LockdownAuth_boots_remaining_tag 2
|
||||
#define meshtastic_LockdownAuth_valid_until_epoch_tag 3
|
||||
#define meshtastic_LockdownAuth_lock_now_tag 4
|
||||
#define meshtastic_LockdownAuth_max_session_seconds_tag 5
|
||||
#define meshtastic_HamParameters_call_sign_tag 1
|
||||
#define meshtastic_HamParameters_tx_power_tag 2
|
||||
#define meshtastic_HamParameters_frequency_tag 3
|
||||
@@ -560,6 +647,7 @@ extern "C" {
|
||||
#define meshtastic_AdminMessage_nodedb_reset_tag 100
|
||||
#define meshtastic_AdminMessage_ota_request_tag 102
|
||||
#define meshtastic_AdminMessage_sensor_config_tag 103
|
||||
#define meshtastic_AdminMessage_lockdown_auth_tag 104
|
||||
#define meshtastic_AdminMessage_session_passkey_tag 101
|
||||
|
||||
/* Struct field encoding specification for nanopb */
|
||||
@@ -621,7 +709,8 @@ X(a, STATIC, ONEOF, INT32, (payload_variant,factory_reset_config,factory
|
||||
X(a, STATIC, ONEOF, BOOL, (payload_variant,nodedb_reset,nodedb_reset), 100) \
|
||||
X(a, STATIC, SINGULAR, BYTES, session_passkey, 101) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,ota_request,ota_request), 102) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,sensor_config,sensor_config), 103)
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,sensor_config,sensor_config), 103) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,lockdown_auth,lockdown_auth), 104)
|
||||
#define meshtastic_AdminMessage_CALLBACK NULL
|
||||
#define meshtastic_AdminMessage_DEFAULT NULL
|
||||
#define meshtastic_AdminMessage_payload_variant_get_channel_response_MSGTYPE meshtastic_Channel
|
||||
@@ -644,6 +733,7 @@ X(a, STATIC, ONEOF, MESSAGE, (payload_variant,sensor_config,sensor_config)
|
||||
#define meshtastic_AdminMessage_payload_variant_key_verification_MSGTYPE meshtastic_KeyVerificationAdmin
|
||||
#define meshtastic_AdminMessage_payload_variant_ota_request_MSGTYPE meshtastic_AdminMessage_OTAEvent
|
||||
#define meshtastic_AdminMessage_payload_variant_sensor_config_MSGTYPE meshtastic_SensorConfig
|
||||
#define meshtastic_AdminMessage_payload_variant_lockdown_auth_MSGTYPE meshtastic_LockdownAuth
|
||||
|
||||
#define meshtastic_AdminMessage_InputEvent_FIELDLIST(X, a) \
|
||||
X(a, STATIC, SINGULAR, UINT32, event_code, 1) \
|
||||
@@ -659,6 +749,15 @@ X(a, STATIC, SINGULAR, BYTES, ota_hash, 2)
|
||||
#define meshtastic_AdminMessage_OTAEvent_CALLBACK NULL
|
||||
#define meshtastic_AdminMessage_OTAEvent_DEFAULT NULL
|
||||
|
||||
#define meshtastic_LockdownAuth_FIELDLIST(X, a) \
|
||||
X(a, STATIC, SINGULAR, BYTES, passphrase, 1) \
|
||||
X(a, STATIC, SINGULAR, UINT32, boots_remaining, 2) \
|
||||
X(a, STATIC, SINGULAR, UINT32, valid_until_epoch, 3) \
|
||||
X(a, STATIC, SINGULAR, BOOL, lock_now, 4) \
|
||||
X(a, STATIC, SINGULAR, UINT32, max_session_seconds, 5)
|
||||
#define meshtastic_LockdownAuth_CALLBACK NULL
|
||||
#define meshtastic_LockdownAuth_DEFAULT NULL
|
||||
|
||||
#define meshtastic_HamParameters_FIELDLIST(X, a) \
|
||||
X(a, STATIC, SINGULAR, STRING, call_sign, 1) \
|
||||
X(a, STATIC, SINGULAR, INT32, tx_power, 2) \
|
||||
@@ -737,6 +836,7 @@ X(a, STATIC, OPTIONAL, UINT32, set_accuracy, 1)
|
||||
extern const pb_msgdesc_t meshtastic_AdminMessage_msg;
|
||||
extern const pb_msgdesc_t meshtastic_AdminMessage_InputEvent_msg;
|
||||
extern const pb_msgdesc_t meshtastic_AdminMessage_OTAEvent_msg;
|
||||
extern const pb_msgdesc_t meshtastic_LockdownAuth_msg;
|
||||
extern const pb_msgdesc_t meshtastic_HamParameters_msg;
|
||||
extern const pb_msgdesc_t meshtastic_NodeRemoteHardwarePinsResponse_msg;
|
||||
extern const pb_msgdesc_t meshtastic_SharedContact_msg;
|
||||
@@ -751,6 +851,7 @@ extern const pb_msgdesc_t meshtastic_SHTXX_config_msg;
|
||||
#define meshtastic_AdminMessage_fields &meshtastic_AdminMessage_msg
|
||||
#define meshtastic_AdminMessage_InputEvent_fields &meshtastic_AdminMessage_InputEvent_msg
|
||||
#define meshtastic_AdminMessage_OTAEvent_fields &meshtastic_AdminMessage_OTAEvent_msg
|
||||
#define meshtastic_LockdownAuth_fields &meshtastic_LockdownAuth_msg
|
||||
#define meshtastic_HamParameters_fields &meshtastic_HamParameters_msg
|
||||
#define meshtastic_NodeRemoteHardwarePinsResponse_fields &meshtastic_NodeRemoteHardwarePinsResponse_msg
|
||||
#define meshtastic_SharedContact_fields &meshtastic_SharedContact_msg
|
||||
@@ -768,6 +869,7 @@ extern const pb_msgdesc_t meshtastic_SHTXX_config_msg;
|
||||
#define meshtastic_AdminMessage_size 511
|
||||
#define meshtastic_HamParameters_size 31
|
||||
#define meshtastic_KeyVerificationAdmin_size 25
|
||||
#define meshtastic_LockdownAuth_size 54
|
||||
#define meshtastic_NodeRemoteHardwarePinsResponse_size 496
|
||||
#define meshtastic_SCD30_config_size 27
|
||||
#define meshtastic_SCD4X_config_size 29
|
||||
|
||||
@@ -33,6 +33,8 @@ typedef struct _meshtastic_PositionLite {
|
||||
uint32_t time;
|
||||
/* TODO: REPLACE */
|
||||
meshtastic_Position_LocSource location_source;
|
||||
/* Indicates the bits of precision set by the sending node */
|
||||
uint32_t precision_bits;
|
||||
} meshtastic_PositionLite;
|
||||
|
||||
typedef PB_BYTES_ARRAY_T(32) meshtastic_UserLite_public_key_t;
|
||||
@@ -211,7 +213,7 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
/* Initializer values for message structs */
|
||||
#define meshtastic_PositionLite_init_default {0, 0, 0, 0, _meshtastic_Position_LocSource_MIN}
|
||||
#define meshtastic_PositionLite_init_default {0, 0, 0, 0, _meshtastic_Position_LocSource_MIN, 0}
|
||||
#define meshtastic_UserLite_init_default {{0}, "", "", _meshtastic_HardwareModel_MIN, 0, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}, false, 0}
|
||||
#define meshtastic_NodeInfoLite_init_default {0, 0, 0, 0, false, 0, 0, 0, "", "", _meshtastic_HardwareModel_MIN, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}}
|
||||
#define meshtastic_DeviceState_init_default {false, meshtastic_MyNodeInfo_init_default, false, meshtastic_User_init_default, 0, {meshtastic_MeshPacket_init_default}, false, meshtastic_MeshPacket_init_default, 0, 0, 0, false, meshtastic_MeshPacket_init_default, 0, {meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default, meshtastic_NodeRemoteHardwarePin_init_default}}
|
||||
@@ -222,7 +224,7 @@ extern "C" {
|
||||
#define meshtastic_NodeDatabase_init_default {0, {0}, {0}, {0}, {0}, {0}}
|
||||
#define meshtastic_ChannelFile_init_default {0, {meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default, meshtastic_Channel_init_default}, 0}
|
||||
#define meshtastic_BackupPreferences_init_default {0, 0, false, meshtastic_LocalConfig_init_default, false, meshtastic_LocalModuleConfig_init_default, false, meshtastic_ChannelFile_init_default, false, meshtastic_User_init_default}
|
||||
#define meshtastic_PositionLite_init_zero {0, 0, 0, 0, _meshtastic_Position_LocSource_MIN}
|
||||
#define meshtastic_PositionLite_init_zero {0, 0, 0, 0, _meshtastic_Position_LocSource_MIN, 0}
|
||||
#define meshtastic_UserLite_init_zero {{0}, "", "", _meshtastic_HardwareModel_MIN, 0, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}, false, 0}
|
||||
#define meshtastic_NodeInfoLite_init_zero {0, 0, 0, 0, false, 0, 0, 0, "", "", _meshtastic_HardwareModel_MIN, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}}
|
||||
#define meshtastic_DeviceState_init_zero {false, meshtastic_MyNodeInfo_init_zero, false, meshtastic_User_init_zero, 0, {meshtastic_MeshPacket_init_zero}, false, meshtastic_MeshPacket_init_zero, 0, 0, 0, false, meshtastic_MeshPacket_init_zero, 0, {meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero, meshtastic_NodeRemoteHardwarePin_init_zero}}
|
||||
@@ -240,6 +242,7 @@ extern "C" {
|
||||
#define meshtastic_PositionLite_altitude_tag 3
|
||||
#define meshtastic_PositionLite_time_tag 4
|
||||
#define meshtastic_PositionLite_location_source_tag 5
|
||||
#define meshtastic_PositionLite_precision_bits_tag 6
|
||||
#define meshtastic_UserLite_macaddr_tag 1
|
||||
#define meshtastic_UserLite_long_name_tag 2
|
||||
#define meshtastic_UserLite_short_name_tag 3
|
||||
@@ -298,7 +301,8 @@ X(a, STATIC, SINGULAR, SFIXED32, latitude_i, 1) \
|
||||
X(a, STATIC, SINGULAR, SFIXED32, longitude_i, 2) \
|
||||
X(a, STATIC, SINGULAR, INT32, altitude, 3) \
|
||||
X(a, STATIC, SINGULAR, FIXED32, time, 4) \
|
||||
X(a, STATIC, SINGULAR, UENUM, location_source, 5)
|
||||
X(a, STATIC, SINGULAR, UENUM, location_source, 5) \
|
||||
X(a, STATIC, SINGULAR, UINT32, precision_bits, 6)
|
||||
#define meshtastic_PositionLite_CALLBACK NULL
|
||||
#define meshtastic_PositionLite_DEFAULT NULL
|
||||
|
||||
@@ -444,13 +448,13 @@ extern const pb_msgdesc_t meshtastic_BackupPreferences_msg;
|
||||
#define MESHTASTIC_MESHTASTIC_DEVICEONLY_PB_H_MAX_SIZE meshtastic_BackupPreferences_size
|
||||
#define meshtastic_BackupPreferences_size 2432
|
||||
#define meshtastic_ChannelFile_size 718
|
||||
#define meshtastic_DeviceState_size 1737
|
||||
#define meshtastic_DeviceState_size 1944
|
||||
#define meshtastic_NodeEnvironmentEntry_size 170
|
||||
#define meshtastic_NodeInfoLite_size 105
|
||||
#define meshtastic_NodePositionEntry_size 36
|
||||
#define meshtastic_NodePositionEntry_size 42
|
||||
#define meshtastic_NodeStatusEntry_size 89
|
||||
#define meshtastic_NodeTelemetryEntry_size 35
|
||||
#define meshtastic_PositionLite_size 28
|
||||
#define meshtastic_PositionLite_size 34
|
||||
#define meshtastic_UserLite_size 98
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
@@ -115,7 +115,7 @@ extern const pb_msgdesc_t meshtastic_NodeDatabase_Legacy_msg;
|
||||
/* Maximum encoded size of messages (where known) */
|
||||
/* meshtastic_NodeDatabase_Legacy_size depends on runtime parameters */
|
||||
#define MESHTASTIC_MESHTASTIC_DEVICEONLY_LEGACY_PB_H_MAX_SIZE meshtastic_NodeInfoLite_Legacy_size
|
||||
#define meshtastic_NodeInfoLite_Legacy_size 196
|
||||
#define meshtastic_NodeInfoLite_Legacy_size 202
|
||||
|
||||
#ifdef __cplusplus
|
||||
} /* extern "C" */
|
||||
|
||||
@@ -57,6 +57,9 @@ PB_BIND(meshtastic_QueueStatus, meshtastic_QueueStatus, AUTO)
|
||||
PB_BIND(meshtastic_FromRadio, meshtastic_FromRadio, 2)
|
||||
|
||||
|
||||
PB_BIND(meshtastic_LockdownStatus, meshtastic_LockdownStatus, AUTO)
|
||||
|
||||
|
||||
PB_BIND(meshtastic_ClientNotification, meshtastic_ClientNotification, 2)
|
||||
|
||||
|
||||
@@ -134,6 +137,8 @@ PB_BIND(meshtastic_ChunkedPayloadResponse, meshtastic_ChunkedPayloadResponse, AU
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -319,6 +319,8 @@ typedef enum _meshtastic_HardwareModel {
|
||||
meshtastic_HardwareModel_HELTEC_V4_R8 = 132,
|
||||
/* The HELTEC_MESH_NODE_T1 uses an NRF52840 chip, plus an SX1262. */
|
||||
meshtastic_HardwareModel_HELTEC_MESH_NODE_T1 = 133,
|
||||
/* B&Q Consulting Station G3: TBD */
|
||||
meshtastic_HardwareModel_STATION_G3 = 134,
|
||||
/* ------------------------------------------------------------------------------------------------------------------------------------------
|
||||
Reserved ID For developing private Ports. These will show up in live traffic sparsely, so we can use a high number. Keep it within 8 bits.
|
||||
------------------------------------------------------------------------------------------------------------------------------------------ */
|
||||
@@ -636,6 +638,25 @@ typedef enum _meshtastic_LogRecord_Level {
|
||||
meshtastic_LogRecord_Level_TRACE = 5
|
||||
} meshtastic_LogRecord_Level;
|
||||
|
||||
typedef enum _meshtastic_LockdownStatus_State {
|
||||
/* Default; should not be sent. */
|
||||
meshtastic_LockdownStatus_State_STATE_UNSPECIFIED = 0,
|
||||
/* No passphrase has ever been provisioned on this device.
|
||||
Client should prompt the operator to set one. */
|
||||
meshtastic_LockdownStatus_State_NEEDS_PROVISION = 1,
|
||||
/* Storage is locked or this client has not authenticated yet.
|
||||
lock_reason carries a machine-readable detail string.
|
||||
Client should present (or auto-replay) a passphrase via
|
||||
AdminMessage.lockdown_auth. */
|
||||
meshtastic_LockdownStatus_State_LOCKED = 2,
|
||||
/* Passphrase accepted; client is now authorized for this connection.
|
||||
boots_remaining and valid_until_epoch describe the active session
|
||||
token's TTL. */
|
||||
meshtastic_LockdownStatus_State_UNLOCKED = 3,
|
||||
/* Passphrase rejected. backoff_seconds is non-zero when rate-limited. */
|
||||
meshtastic_LockdownStatus_State_UNLOCK_FAILED = 4
|
||||
} meshtastic_LockdownStatus_State;
|
||||
|
||||
/* Struct definitions */
|
||||
/* A GPS Position */
|
||||
typedef struct _meshtastic_Position {
|
||||
@@ -799,6 +820,7 @@ typedef struct _meshtastic_Routing {
|
||||
} meshtastic_Routing;
|
||||
|
||||
typedef PB_BYTES_ARRAY_T(233) meshtastic_Data_payload_t;
|
||||
typedef PB_BYTES_ARRAY_T(64) meshtastic_Data_xeddsa_signature_t;
|
||||
/* (Formerly called SubPacket)
|
||||
The payload portion fo a packet, this is the actual bytes that are sent
|
||||
inside a radio packet (because from/to are broken out by the comms library) */
|
||||
@@ -832,6 +854,8 @@ typedef struct _meshtastic_Data {
|
||||
/* Bitfield for extra flags. First use is to indicate that user approves the packet being uploaded to MQTT. */
|
||||
bool has_bitfield;
|
||||
uint8_t bitfield;
|
||||
/* XEdDSA signature for the payload */
|
||||
meshtastic_Data_xeddsa_signature_t xeddsa_signature;
|
||||
} meshtastic_Data;
|
||||
|
||||
typedef PB_BYTES_ARRAY_T(32) meshtastic_KeyVerification_hash1_t;
|
||||
@@ -1036,6 +1060,8 @@ typedef struct _meshtastic_MeshPacket {
|
||||
uint32_t tx_after;
|
||||
/* Indicates which transport mechanism this packet arrived over */
|
||||
meshtastic_MeshPacket_TransportMechanism transport_mechanism;
|
||||
/* Indicates whether the packet has a valid signature */
|
||||
bool xeddsa_signed;
|
||||
} meshtastic_MeshPacket;
|
||||
|
||||
/* The bluetooth to device link:
|
||||
@@ -1092,6 +1118,10 @@ typedef struct _meshtastic_NodeInfo {
|
||||
/* True if node has been muted
|
||||
Persistes between NodeDB internal clean ups */
|
||||
bool is_muted;
|
||||
/* True if node is signing its packets via XEdDSA
|
||||
Persists between NodeDB internal clean ups
|
||||
LSB 1 of the bitfield */
|
||||
bool has_xeddsa_signed;
|
||||
} meshtastic_NodeInfo;
|
||||
|
||||
typedef PB_BYTES_ARRAY_T(16) meshtastic_MyNodeInfo_device_id_t;
|
||||
@@ -1146,6 +1176,38 @@ typedef struct _meshtastic_QueueStatus {
|
||||
uint32_t mesh_packet_id;
|
||||
} meshtastic_QueueStatus;
|
||||
|
||||
/* Lockdown state report from firmware to client (for hardened builds
|
||||
with MESHTASTIC_LOCKDOWN). Sent immediately after config_complete_id
|
||||
to inform a freshly-connected unauthorized client what it must do,
|
||||
and again in response to each LockdownAuth admin command. */
|
||||
typedef struct _meshtastic_LockdownStatus {
|
||||
/* Current lockdown state being reported. */
|
||||
meshtastic_LockdownStatus_State state;
|
||||
/* For LOCKED: machine-readable reason. Known values:
|
||||
"needs_auth" — storage already unlocked, client must auth
|
||||
"token_missing" — no boot token on flash
|
||||
"token_expired" — boot token wall-clock TTL elapsed
|
||||
"token_boots_zero" — boot token boot-count TTL exhausted
|
||||
"token_hmac_fail" — token tampered or wrong device
|
||||
"token_dek_fail" — token DEK decrypt failed
|
||||
"token_wrong_size" — token file corrupted
|
||||
"token_bad_magic" — token file corrupted
|
||||
"not_provisioned" — should generally use NEEDS_PROVISION state instead
|
||||
Other values may be added; clients should treat unknown values as
|
||||
"locked, ask for passphrase". */
|
||||
char lock_reason[32];
|
||||
/* For UNLOCKED: remaining boots on the issued session token.
|
||||
Decrements by 1 on each subsequent boot. */
|
||||
uint32_t boots_remaining;
|
||||
/* For UNLOCKED: wall-clock expiry of the issued session token,
|
||||
absolute Unix-epoch seconds. 0 = no time limit. */
|
||||
uint32_t valid_until_epoch;
|
||||
/* For UNLOCK_FAILED: seconds the client must wait before another
|
||||
passphrase attempt will be accepted. 0 = wrong passphrase, no
|
||||
backoff (immediate retry allowed but advisable to prompt user). */
|
||||
uint32_t backoff_seconds;
|
||||
} meshtastic_LockdownStatus;
|
||||
|
||||
typedef struct _meshtastic_KeyVerificationNumberInform {
|
||||
uint64_t nonce;
|
||||
char remote_longname[40];
|
||||
@@ -1319,6 +1381,12 @@ typedef struct _meshtastic_FromRadio {
|
||||
meshtastic_ClientNotification clientNotification;
|
||||
/* Persistent data for device-ui */
|
||||
meshtastic_DeviceUIConfig deviceuiConfig;
|
||||
/* Lockdown state notification for hardened firmware builds.
|
||||
Sent post-config (so unauthorized clients learn they must
|
||||
provision/unlock) and after each LockdownAuth admin command
|
||||
to report success or failure. Replaces the earlier scheme of
|
||||
encoding state as magic-string prefixes inside ClientNotification. */
|
||||
meshtastic_LockdownStatus lockdown_status;
|
||||
};
|
||||
} meshtastic_FromRadio;
|
||||
|
||||
@@ -1460,6 +1528,10 @@ extern "C" {
|
||||
#define _meshtastic_LogRecord_Level_MAX meshtastic_LogRecord_Level_CRITICAL
|
||||
#define _meshtastic_LogRecord_Level_ARRAYSIZE ((meshtastic_LogRecord_Level)(meshtastic_LogRecord_Level_CRITICAL+1))
|
||||
|
||||
#define _meshtastic_LockdownStatus_State_MIN meshtastic_LockdownStatus_State_STATE_UNSPECIFIED
|
||||
#define _meshtastic_LockdownStatus_State_MAX meshtastic_LockdownStatus_State_UNLOCK_FAILED
|
||||
#define _meshtastic_LockdownStatus_State_ARRAYSIZE ((meshtastic_LockdownStatus_State)(meshtastic_LockdownStatus_State_UNLOCK_FAILED+1))
|
||||
|
||||
#define meshtastic_Position_location_source_ENUMTYPE meshtastic_Position_LocSource
|
||||
#define meshtastic_Position_altitude_source_ENUMTYPE meshtastic_Position_AltSource
|
||||
|
||||
@@ -1490,6 +1562,8 @@ extern "C" {
|
||||
|
||||
|
||||
|
||||
#define meshtastic_LockdownStatus_state_ENUMTYPE meshtastic_LockdownStatus_State
|
||||
|
||||
#define meshtastic_ClientNotification_level_ENUMTYPE meshtastic_LogRecord_Level
|
||||
|
||||
|
||||
@@ -1517,19 +1591,20 @@ extern "C" {
|
||||
#define meshtastic_User_init_default {"", "", "", {0}, _meshtastic_HardwareModel_MIN, 0, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}, false, 0}
|
||||
#define meshtastic_RouteDiscovery_init_default {0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
||||
#define meshtastic_Routing_init_default {0, {meshtastic_RouteDiscovery_init_default}}
|
||||
#define meshtastic_Data_init_default {_meshtastic_PortNum_MIN, {0, {0}}, 0, 0, 0, 0, 0, 0, false, 0}
|
||||
#define meshtastic_Data_init_default {_meshtastic_PortNum_MIN, {0, {0}}, 0, 0, 0, 0, 0, 0, false, 0, {0, {0}}}
|
||||
#define meshtastic_KeyVerification_init_default {0, {0, {0}}, {0, {0}}}
|
||||
#define meshtastic_StoreForwardPlusPlus_init_default {_meshtastic_StoreForwardPlusPlus_SFPP_message_type_MIN, {0, {0}}, {0, {0}}, {0, {0}}, {0, {0}}, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_RemoteShell_init_default {_meshtastic_RemoteShell_OpCode_MIN, 0, 0, 0, {0, {0}}, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_Waypoint_init_default {0, false, 0, false, 0, 0, 0, "", "", 0}
|
||||
#define meshtastic_StatusMessage_init_default {""}
|
||||
#define meshtastic_MqttClientProxyMessage_init_default {"", 0, {{0, {0}}}, 0}
|
||||
#define meshtastic_MeshPacket_init_default {0, 0, 0, 0, {meshtastic_Data_init_default}, 0, 0, 0, 0, 0, _meshtastic_MeshPacket_Priority_MIN, 0, _meshtastic_MeshPacket_Delayed_MIN, 0, 0, {0, {0}}, 0, 0, 0, 0, _meshtastic_MeshPacket_TransportMechanism_MIN}
|
||||
#define meshtastic_NodeInfo_init_default {0, false, meshtastic_User_init_default, false, meshtastic_Position_init_default, 0, 0, false, meshtastic_DeviceMetrics_init_default, 0, 0, false, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_MeshPacket_init_default {0, 0, 0, 0, {meshtastic_Data_init_default}, 0, 0, 0, 0, 0, _meshtastic_MeshPacket_Priority_MIN, 0, _meshtastic_MeshPacket_Delayed_MIN, 0, 0, {0, {0}}, 0, 0, 0, 0, _meshtastic_MeshPacket_TransportMechanism_MIN, 0}
|
||||
#define meshtastic_NodeInfo_init_default {0, false, meshtastic_User_init_default, false, meshtastic_Position_init_default, 0, 0, false, meshtastic_DeviceMetrics_init_default, 0, 0, false, 0, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_MyNodeInfo_init_default {0, 0, 0, {0, {0}}, "", _meshtastic_FirmwareEdition_MIN, 0}
|
||||
#define meshtastic_LogRecord_init_default {"", 0, "", _meshtastic_LogRecord_Level_MIN}
|
||||
#define meshtastic_QueueStatus_init_default {0, 0, 0, 0}
|
||||
#define meshtastic_FromRadio_init_default {0, 0, {meshtastic_MeshPacket_init_default}}
|
||||
#define meshtastic_LockdownStatus_init_default {_meshtastic_LockdownStatus_State_MIN, "", 0, 0, 0}
|
||||
#define meshtastic_ClientNotification_init_default {false, 0, 0, _meshtastic_LogRecord_Level_MIN, "", 0, {meshtastic_KeyVerificationNumberInform_init_default}}
|
||||
#define meshtastic_KeyVerificationNumberInform_init_default {0, "", 0}
|
||||
#define meshtastic_KeyVerificationNumberRequest_init_default {0, ""}
|
||||
@@ -1551,19 +1626,20 @@ extern "C" {
|
||||
#define meshtastic_User_init_zero {"", "", "", {0}, _meshtastic_HardwareModel_MIN, 0, _meshtastic_Config_DeviceConfig_Role_MIN, {0, {0}}, false, 0}
|
||||
#define meshtastic_RouteDiscovery_init_zero {0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}, 0, {0, 0, 0, 0, 0, 0, 0, 0}}
|
||||
#define meshtastic_Routing_init_zero {0, {meshtastic_RouteDiscovery_init_zero}}
|
||||
#define meshtastic_Data_init_zero {_meshtastic_PortNum_MIN, {0, {0}}, 0, 0, 0, 0, 0, 0, false, 0}
|
||||
#define meshtastic_Data_init_zero {_meshtastic_PortNum_MIN, {0, {0}}, 0, 0, 0, 0, 0, 0, false, 0, {0, {0}}}
|
||||
#define meshtastic_KeyVerification_init_zero {0, {0, {0}}, {0, {0}}}
|
||||
#define meshtastic_StoreForwardPlusPlus_init_zero {_meshtastic_StoreForwardPlusPlus_SFPP_message_type_MIN, {0, {0}}, {0, {0}}, {0, {0}}, {0, {0}}, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_RemoteShell_init_zero {_meshtastic_RemoteShell_OpCode_MIN, 0, 0, 0, {0, {0}}, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_Waypoint_init_zero {0, false, 0, false, 0, 0, 0, "", "", 0}
|
||||
#define meshtastic_StatusMessage_init_zero {""}
|
||||
#define meshtastic_MqttClientProxyMessage_init_zero {"", 0, {{0, {0}}}, 0}
|
||||
#define meshtastic_MeshPacket_init_zero {0, 0, 0, 0, {meshtastic_Data_init_zero}, 0, 0, 0, 0, 0, _meshtastic_MeshPacket_Priority_MIN, 0, _meshtastic_MeshPacket_Delayed_MIN, 0, 0, {0, {0}}, 0, 0, 0, 0, _meshtastic_MeshPacket_TransportMechanism_MIN}
|
||||
#define meshtastic_NodeInfo_init_zero {0, false, meshtastic_User_init_zero, false, meshtastic_Position_init_zero, 0, 0, false, meshtastic_DeviceMetrics_init_zero, 0, 0, false, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_MeshPacket_init_zero {0, 0, 0, 0, {meshtastic_Data_init_zero}, 0, 0, 0, 0, 0, _meshtastic_MeshPacket_Priority_MIN, 0, _meshtastic_MeshPacket_Delayed_MIN, 0, 0, {0, {0}}, 0, 0, 0, 0, _meshtastic_MeshPacket_TransportMechanism_MIN, 0}
|
||||
#define meshtastic_NodeInfo_init_zero {0, false, meshtastic_User_init_zero, false, meshtastic_Position_init_zero, 0, 0, false, meshtastic_DeviceMetrics_init_zero, 0, 0, false, 0, 0, 0, 0, 0, 0}
|
||||
#define meshtastic_MyNodeInfo_init_zero {0, 0, 0, {0, {0}}, "", _meshtastic_FirmwareEdition_MIN, 0}
|
||||
#define meshtastic_LogRecord_init_zero {"", 0, "", _meshtastic_LogRecord_Level_MIN}
|
||||
#define meshtastic_QueueStatus_init_zero {0, 0, 0, 0}
|
||||
#define meshtastic_FromRadio_init_zero {0, 0, {meshtastic_MeshPacket_init_zero}}
|
||||
#define meshtastic_LockdownStatus_init_zero {_meshtastic_LockdownStatus_State_MIN, "", 0, 0, 0}
|
||||
#define meshtastic_ClientNotification_init_zero {false, 0, 0, _meshtastic_LogRecord_Level_MIN, "", 0, {meshtastic_KeyVerificationNumberInform_init_zero}}
|
||||
#define meshtastic_KeyVerificationNumberInform_init_zero {0, "", 0}
|
||||
#define meshtastic_KeyVerificationNumberRequest_init_zero {0, ""}
|
||||
@@ -1631,6 +1707,7 @@ extern "C" {
|
||||
#define meshtastic_Data_reply_id_tag 7
|
||||
#define meshtastic_Data_emoji_tag 8
|
||||
#define meshtastic_Data_bitfield_tag 9
|
||||
#define meshtastic_Data_xeddsa_signature_tag 10
|
||||
#define meshtastic_KeyVerification_nonce_tag 1
|
||||
#define meshtastic_KeyVerification_hash1_tag 2
|
||||
#define meshtastic_KeyVerification_hash2_tag 3
|
||||
@@ -1688,6 +1765,7 @@ extern "C" {
|
||||
#define meshtastic_MeshPacket_relay_node_tag 19
|
||||
#define meshtastic_MeshPacket_tx_after_tag 20
|
||||
#define meshtastic_MeshPacket_transport_mechanism_tag 21
|
||||
#define meshtastic_MeshPacket_xeddsa_signed_tag 22
|
||||
#define meshtastic_NodeInfo_num_tag 1
|
||||
#define meshtastic_NodeInfo_user_tag 2
|
||||
#define meshtastic_NodeInfo_position_tag 3
|
||||
@@ -1701,6 +1779,7 @@ extern "C" {
|
||||
#define meshtastic_NodeInfo_is_ignored_tag 11
|
||||
#define meshtastic_NodeInfo_is_key_manually_verified_tag 12
|
||||
#define meshtastic_NodeInfo_is_muted_tag 13
|
||||
#define meshtastic_NodeInfo_has_xeddsa_signed_tag 14
|
||||
#define meshtastic_MyNodeInfo_my_node_num_tag 1
|
||||
#define meshtastic_MyNodeInfo_reboot_count_tag 8
|
||||
#define meshtastic_MyNodeInfo_min_app_version_tag 11
|
||||
@@ -1716,6 +1795,11 @@ extern "C" {
|
||||
#define meshtastic_QueueStatus_free_tag 2
|
||||
#define meshtastic_QueueStatus_maxlen_tag 3
|
||||
#define meshtastic_QueueStatus_mesh_packet_id_tag 4
|
||||
#define meshtastic_LockdownStatus_state_tag 1
|
||||
#define meshtastic_LockdownStatus_lock_reason_tag 2
|
||||
#define meshtastic_LockdownStatus_boots_remaining_tag 3
|
||||
#define meshtastic_LockdownStatus_valid_until_epoch_tag 4
|
||||
#define meshtastic_LockdownStatus_backoff_seconds_tag 5
|
||||
#define meshtastic_KeyVerificationNumberInform_nonce_tag 1
|
||||
#define meshtastic_KeyVerificationNumberInform_remote_longname_tag 2
|
||||
#define meshtastic_KeyVerificationNumberInform_security_number_tag 3
|
||||
@@ -1775,6 +1859,7 @@ extern "C" {
|
||||
#define meshtastic_FromRadio_fileInfo_tag 15
|
||||
#define meshtastic_FromRadio_clientNotification_tag 16
|
||||
#define meshtastic_FromRadio_deviceuiConfig_tag 17
|
||||
#define meshtastic_FromRadio_lockdown_status_tag 18
|
||||
#define meshtastic_Heartbeat_nonce_tag 1
|
||||
#define meshtastic_ToRadio_packet_tag 1
|
||||
#define meshtastic_ToRadio_want_config_id_tag 3
|
||||
@@ -1861,7 +1946,8 @@ X(a, STATIC, SINGULAR, FIXED32, source, 5) \
|
||||
X(a, STATIC, SINGULAR, FIXED32, request_id, 6) \
|
||||
X(a, STATIC, SINGULAR, FIXED32, reply_id, 7) \
|
||||
X(a, STATIC, SINGULAR, FIXED32, emoji, 8) \
|
||||
X(a, STATIC, OPTIONAL, UINT32, bitfield, 9)
|
||||
X(a, STATIC, OPTIONAL, UINT32, bitfield, 9) \
|
||||
X(a, STATIC, SINGULAR, BYTES, xeddsa_signature, 10)
|
||||
#define meshtastic_Data_CALLBACK NULL
|
||||
#define meshtastic_Data_DEFAULT NULL
|
||||
|
||||
@@ -1946,7 +2032,8 @@ X(a, STATIC, SINGULAR, BOOL, pki_encrypted, 17) \
|
||||
X(a, STATIC, SINGULAR, UINT32, next_hop, 18) \
|
||||
X(a, STATIC, SINGULAR, UINT32, relay_node, 19) \
|
||||
X(a, STATIC, SINGULAR, UINT32, tx_after, 20) \
|
||||
X(a, STATIC, SINGULAR, UENUM, transport_mechanism, 21)
|
||||
X(a, STATIC, SINGULAR, UENUM, transport_mechanism, 21) \
|
||||
X(a, STATIC, SINGULAR, BOOL, xeddsa_signed, 22)
|
||||
#define meshtastic_MeshPacket_CALLBACK NULL
|
||||
#define meshtastic_MeshPacket_DEFAULT NULL
|
||||
#define meshtastic_MeshPacket_payload_variant_decoded_MSGTYPE meshtastic_Data
|
||||
@@ -1964,7 +2051,8 @@ X(a, STATIC, OPTIONAL, UINT32, hops_away, 9) \
|
||||
X(a, STATIC, SINGULAR, BOOL, is_favorite, 10) \
|
||||
X(a, STATIC, SINGULAR, BOOL, is_ignored, 11) \
|
||||
X(a, STATIC, SINGULAR, BOOL, is_key_manually_verified, 12) \
|
||||
X(a, STATIC, SINGULAR, BOOL, is_muted, 13)
|
||||
X(a, STATIC, SINGULAR, BOOL, is_muted, 13) \
|
||||
X(a, STATIC, SINGULAR, BOOL, has_xeddsa_signed, 14)
|
||||
#define meshtastic_NodeInfo_CALLBACK NULL
|
||||
#define meshtastic_NodeInfo_DEFAULT NULL
|
||||
#define meshtastic_NodeInfo_user_MSGTYPE meshtastic_User
|
||||
@@ -2015,7 +2103,8 @@ X(a, STATIC, ONEOF, MESSAGE, (payload_variant,metadata,metadata), 13) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,mqttClientProxyMessage,mqttClientProxyMessage), 14) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,fileInfo,fileInfo), 15) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,clientNotification,clientNotification), 16) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,deviceuiConfig,deviceuiConfig), 17)
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,deviceuiConfig,deviceuiConfig), 17) \
|
||||
X(a, STATIC, ONEOF, MESSAGE, (payload_variant,lockdown_status,lockdown_status), 18)
|
||||
#define meshtastic_FromRadio_CALLBACK NULL
|
||||
#define meshtastic_FromRadio_DEFAULT NULL
|
||||
#define meshtastic_FromRadio_payload_variant_packet_MSGTYPE meshtastic_MeshPacket
|
||||
@@ -2032,6 +2121,16 @@ X(a, STATIC, ONEOF, MESSAGE, (payload_variant,deviceuiConfig,deviceuiConfi
|
||||
#define meshtastic_FromRadio_payload_variant_fileInfo_MSGTYPE meshtastic_FileInfo
|
||||
#define meshtastic_FromRadio_payload_variant_clientNotification_MSGTYPE meshtastic_ClientNotification
|
||||
#define meshtastic_FromRadio_payload_variant_deviceuiConfig_MSGTYPE meshtastic_DeviceUIConfig
|
||||
#define meshtastic_FromRadio_payload_variant_lockdown_status_MSGTYPE meshtastic_LockdownStatus
|
||||
|
||||
#define meshtastic_LockdownStatus_FIELDLIST(X, a) \
|
||||
X(a, STATIC, SINGULAR, UENUM, state, 1) \
|
||||
X(a, STATIC, SINGULAR, STRING, lock_reason, 2) \
|
||||
X(a, STATIC, SINGULAR, UINT32, boots_remaining, 3) \
|
||||
X(a, STATIC, SINGULAR, UINT32, valid_until_epoch, 4) \
|
||||
X(a, STATIC, SINGULAR, UINT32, backoff_seconds, 5)
|
||||
#define meshtastic_LockdownStatus_CALLBACK NULL
|
||||
#define meshtastic_LockdownStatus_DEFAULT NULL
|
||||
|
||||
#define meshtastic_ClientNotification_FIELDLIST(X, a) \
|
||||
X(a, STATIC, OPTIONAL, UINT32, reply_id, 1) \
|
||||
@@ -2192,6 +2291,7 @@ extern const pb_msgdesc_t meshtastic_MyNodeInfo_msg;
|
||||
extern const pb_msgdesc_t meshtastic_LogRecord_msg;
|
||||
extern const pb_msgdesc_t meshtastic_QueueStatus_msg;
|
||||
extern const pb_msgdesc_t meshtastic_FromRadio_msg;
|
||||
extern const pb_msgdesc_t meshtastic_LockdownStatus_msg;
|
||||
extern const pb_msgdesc_t meshtastic_ClientNotification_msg;
|
||||
extern const pb_msgdesc_t meshtastic_KeyVerificationNumberInform_msg;
|
||||
extern const pb_msgdesc_t meshtastic_KeyVerificationNumberRequest_msg;
|
||||
@@ -2228,6 +2328,7 @@ extern const pb_msgdesc_t meshtastic_ChunkedPayloadResponse_msg;
|
||||
#define meshtastic_LogRecord_fields &meshtastic_LogRecord_msg
|
||||
#define meshtastic_QueueStatus_fields &meshtastic_QueueStatus_msg
|
||||
#define meshtastic_FromRadio_fields &meshtastic_FromRadio_msg
|
||||
#define meshtastic_LockdownStatus_fields &meshtastic_LockdownStatus_msg
|
||||
#define meshtastic_ClientNotification_fields &meshtastic_ClientNotification_msg
|
||||
#define meshtastic_KeyVerificationNumberInform_fields &meshtastic_KeyVerificationNumberInform_msg
|
||||
#define meshtastic_KeyVerificationNumberRequest_fields &meshtastic_KeyVerificationNumberRequest_msg
|
||||
@@ -2253,7 +2354,7 @@ extern const pb_msgdesc_t meshtastic_ChunkedPayloadResponse_msg;
|
||||
#define meshtastic_ChunkedPayload_size 245
|
||||
#define meshtastic_ClientNotification_size 482
|
||||
#define meshtastic_Compressed_size 239
|
||||
#define meshtastic_Data_size 269
|
||||
#define meshtastic_Data_size 335
|
||||
#define meshtastic_DeviceMetadata_size 54
|
||||
#define meshtastic_DuplicatedPublicKey_size 0
|
||||
#define meshtastic_FileInfo_size 236
|
||||
@@ -2263,14 +2364,15 @@ extern const pb_msgdesc_t meshtastic_ChunkedPayloadResponse_msg;
|
||||
#define meshtastic_KeyVerificationNumberInform_size 58
|
||||
#define meshtastic_KeyVerificationNumberRequest_size 52
|
||||
#define meshtastic_KeyVerification_size 79
|
||||
#define meshtastic_LockdownStatus_size 53
|
||||
#define meshtastic_LogRecord_size 426
|
||||
#define meshtastic_LowEntropyKey_size 0
|
||||
#define meshtastic_MeshPacket_size 381
|
||||
#define meshtastic_MeshPacket_size 450
|
||||
#define meshtastic_MqttClientProxyMessage_size 501
|
||||
#define meshtastic_MyNodeInfo_size 83
|
||||
#define meshtastic_NeighborInfo_size 258
|
||||
#define meshtastic_Neighbor_size 22
|
||||
#define meshtastic_NodeInfo_size 325
|
||||
#define meshtastic_NodeInfo_size 327
|
||||
#define meshtastic_NodeRemoteHardwarePin_size 29
|
||||
#define meshtastic_Position_size 144
|
||||
#define meshtastic_QueueStatus_size 23
|
||||
|
||||
@@ -0,0 +1,18 @@
|
||||
#pragma once
|
||||
|
||||
#include <stddef.h>
|
||||
#include <stdint.h>
|
||||
|
||||
// IEEE 802 Local Experimental EtherType 1, valid on private LANs. Carries a
|
||||
// Meshtastic RadioBuffer (PacketHeader + payload, ≤255 bytes) end-to-end so the
|
||||
// LoRa wire format is preserved on HaLow.
|
||||
static constexpr uint16_t ETHERTYPE_MESHTASTIC_HALOW = 0x88B5;
|
||||
|
||||
static constexpr uint8_t HALOW_BROADCAST_MAC[6] = {0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF};
|
||||
|
||||
struct __attribute__((packed)) HaLowEthFrameHeader {
|
||||
uint8_t dst[6];
|
||||
uint8_t src[6];
|
||||
uint16_t ethertype; // network byte order on the wire
|
||||
};
|
||||
static_assert(sizeof(HaLowEthFrameHeader) == 14, "HaLow ethernet header must be 14 bytes");
|
||||
@@ -0,0 +1,287 @@
|
||||
#include "configuration.h"
|
||||
#ifdef USE_HALOW_RADIO
|
||||
|
||||
#include "HaLowFrame.h"
|
||||
#include "HaLowInterface.h"
|
||||
#include "MeshTypes.h"
|
||||
#include "RTC.h" // getValidTime / RTCQualityFromNet
|
||||
#include <string.h>
|
||||
#if HAS_UDP_MULTICAST
|
||||
#include "main.h" // for `udpHandler`
|
||||
#include "mesh/generated/meshtastic/config.pb.h"
|
||||
#endif
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
extern "C" {
|
||||
#include "mmhal.h"
|
||||
#include "mmipal.h"
|
||||
#include "mmwlan.h"
|
||||
#include "mmwlan_regdb.def"
|
||||
}
|
||||
|
||||
#ifndef HALOW_COUNTRY_CODE
|
||||
#define HALOW_COUNTRY_CODE "US"
|
||||
#endif
|
||||
// SSID/PSK supplied at build time. Empty SSID means "don't auto-associate" —
|
||||
// the chip boots and idles, useful for testing without an AP nearby.
|
||||
#ifndef HALOW_SSID
|
||||
#define HALOW_SSID ""
|
||||
#endif
|
||||
#ifndef HALOW_PASSPHRASE
|
||||
#define HALOW_PASSPHRASE ""
|
||||
#endif
|
||||
#endif
|
||||
|
||||
HaLowInterface::HaLowInterface() : concurrency::OSThread("HaLow") {}
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
// Static glue so the C callbacks can reach into the (non-static) instance.
|
||||
// Only one HaLowInterface exists, owned by Router::iface or constructed at
|
||||
// boot, so a single pointer is sufficient.
|
||||
static HaLowInterface *s_instance = nullptr;
|
||||
|
||||
static void halow_link_state_cb(enum mmwlan_link_state link_state, void *arg)
|
||||
{
|
||||
(void)arg;
|
||||
if (link_state == MMWLAN_LINK_UP) {
|
||||
struct mmipal_ip_config ipcfg = {};
|
||||
if (mmipal_get_ip_config(&ipcfg) == MMIPAL_SUCCESS) {
|
||||
LOG_INFO("HaLow: link UP, ip=%s netmask=%s gw=%s", ipcfg.ip_addr, ipcfg.netmask, ipcfg.gateway_addr);
|
||||
} else {
|
||||
LOG_INFO("HaLow: link UP (no IP yet)");
|
||||
}
|
||||
int32_t rssi = mmwlan_get_rssi();
|
||||
if (rssi != INT32_MIN) {
|
||||
LOG_INFO("HaLow: AP RSSI %ld dBm", (long)rssi);
|
||||
}
|
||||
} else {
|
||||
LOG_INFO("HaLow: link DOWN");
|
||||
}
|
||||
}
|
||||
|
||||
// mmwlan delivers Ethernet-framed packets here: 14-byte 802.3 header + payload.
|
||||
// The payload is whatever EtherType we used on the TX side — we filter for our
|
||||
// own marker and decode the inner RadioBuffer.
|
||||
void HaLowInterface::rxTrampoline(uint8_t *header, unsigned header_len, uint8_t *payload, unsigned payload_len, void *arg)
|
||||
{
|
||||
HaLowInterface *self = static_cast<HaLowInterface *>(arg);
|
||||
if (!self || header_len < sizeof(HaLowEthFrameHeader)) {
|
||||
return;
|
||||
}
|
||||
// EtherType is big-endian in the header (bytes 12-13).
|
||||
uint16_t et = ((uint16_t)header[12] << 8) | header[13];
|
||||
if (et != ETHERTYPE_MESHTASTIC_HALOW) {
|
||||
return;
|
||||
}
|
||||
self->onFrameReceived(payload, payload_len, /*rssi*/ 0);
|
||||
}
|
||||
#endif
|
||||
|
||||
HaLowInterface::~HaLowInterface() = default;
|
||||
|
||||
bool HaLowInterface::init()
|
||||
{
|
||||
RadioInterface::init();
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
LOG_INFO("HaLow: mmhal_init()");
|
||||
mmhal_init();
|
||||
|
||||
LOG_INFO("HaLow: mmwlan_init()");
|
||||
mmwlan_init();
|
||||
|
||||
const struct mmwlan_s1g_channel_list *channel_list = mmwlan_lookup_regulatory_domain(get_regulatory_db(), HALOW_COUNTRY_CODE);
|
||||
if (!channel_list) {
|
||||
LOG_ERROR("HaLow: country %s not in regdb", HALOW_COUNTRY_CODE);
|
||||
return false;
|
||||
}
|
||||
if (mmwlan_set_channel_list(channel_list) != MMWLAN_SUCCESS) {
|
||||
LOG_ERROR("HaLow: set_channel_list failed");
|
||||
return false;
|
||||
}
|
||||
|
||||
struct mmwlan_boot_args boot_args = MMWLAN_BOOT_ARGS_INIT;
|
||||
enum mmwlan_status st = mmwlan_boot(&boot_args);
|
||||
if (st != MMWLAN_SUCCESS) {
|
||||
LOG_ERROR("HaLow: mmwlan_boot failed (%d) — firmware load or SPI wiring", (int)st);
|
||||
return false;
|
||||
}
|
||||
|
||||
struct mmwlan_version version;
|
||||
if (mmwlan_get_version(&version) == MMWLAN_SUCCESS) {
|
||||
LOG_INFO("HaLow: chip 0x%lx, fw %s, lib %s", (unsigned long)version.morse_chip_id, version.morse_fw_version,
|
||||
version.morselib_version);
|
||||
}
|
||||
|
||||
// Bring up the LWIP netif (DHCP by default). mmipal plugs into the
|
||||
// Arduino-ESP32 framework's LWIP — no separate stack.
|
||||
struct mmipal_init_args ipal_args = MMIPAL_INIT_ARGS_DEFAULT;
|
||||
if (mmipal_init(&ipal_args) != MMIPAL_SUCCESS) {
|
||||
LOG_ERROR("HaLow: mmipal_init failed");
|
||||
return false;
|
||||
}
|
||||
|
||||
if (HALOW_SSID[0] == '\0') {
|
||||
LOG_INFO("HaLow: no SSID configured, chip will idle (set -DHALOW_SSID=...)");
|
||||
return false;
|
||||
}
|
||||
|
||||
struct mmwlan_sta_args sta_args = MMWLAN_STA_ARGS_INIT;
|
||||
sta_args.ssid_len = strnlen(HALOW_SSID, sizeof(sta_args.ssid));
|
||||
memcpy(sta_args.ssid, HALOW_SSID, sta_args.ssid_len);
|
||||
sta_args.passphrase_len = strnlen(HALOW_PASSPHRASE, sizeof(sta_args.passphrase));
|
||||
memcpy(sta_args.passphrase, HALOW_PASSPHRASE, sta_args.passphrase_len);
|
||||
sta_args.security_type = (sta_args.passphrase_len > 0) ? MMWLAN_SAE : MMWLAN_OPEN;
|
||||
|
||||
s_instance = this;
|
||||
mmwlan_register_link_state_cb(halow_link_state_cb, NULL);
|
||||
if (mmwlan_register_rx_cb(rxTrampoline, this) != MMWLAN_SUCCESS) {
|
||||
LOG_ERROR("HaLow: register_rx_cb failed");
|
||||
return false;
|
||||
}
|
||||
|
||||
LOG_INFO("HaLow: associating with SSID '%s'", HALOW_SSID);
|
||||
if (mmwlan_sta_enable(&sta_args, NULL) != MMWLAN_SUCCESS) {
|
||||
LOG_ERROR("HaLow: mmwlan_sta_enable failed");
|
||||
return false;
|
||||
}
|
||||
|
||||
// From here on out, HaLow is the radio. send() encodes packets as 802.3
|
||||
// frames addressed to broadcast MAC with EtherType 0x88B5; the AP relays
|
||||
// them to all associated STAs (Phase 3 closes the AP-less gap).
|
||||
return true;
|
||||
#else
|
||||
LOG_WARN("HaLow: built without USE_MM_IOT_ESP32, transport is a stub");
|
||||
return false;
|
||||
#endif
|
||||
}
|
||||
|
||||
bool HaLowInterface::reconfigure()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
bool HaLowInterface::sleep()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
bool HaLowInterface::canSleep()
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
ErrorCode HaLowInterface::send(meshtastic_MeshPacket *p)
|
||||
{
|
||||
if (!p) {
|
||||
return ERRNO_UNKNOWN;
|
||||
}
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
// beginSending() serializes the MeshPacket into radioBuffer (PacketHeader
|
||||
// + payload). We then prepend a 14-byte 802.3 header so mmwlan can wrap
|
||||
// it as an 802.11 data frame and ship it through the AP.
|
||||
size_t encoded = beginSending(p);
|
||||
if (encoded == 0) {
|
||||
packetPool.release(p);
|
||||
return ERRNO_UNKNOWN;
|
||||
}
|
||||
|
||||
uint8_t txbuf[sizeof(HaLowEthFrameHeader) + sizeof(RadioBuffer)];
|
||||
if (encoded > sizeof(RadioBuffer)) {
|
||||
LOG_ERROR("HaLow: encoded %u > radioBuffer", (unsigned)encoded);
|
||||
packetPool.release(p);
|
||||
return ERRNO_UNKNOWN;
|
||||
}
|
||||
|
||||
// Ethernet header: DA(6) || SA(6) || EtherType(2, big-endian).
|
||||
memcpy(txbuf, HALOW_BROADCAST_MAC, 6);
|
||||
if (mmwlan_get_mac_addr(txbuf + 6) != MMWLAN_SUCCESS) {
|
||||
memset(txbuf + 6, 0, 6); // fallback so the frame still goes out
|
||||
}
|
||||
txbuf[12] = (uint8_t)(ETHERTYPE_MESHTASTIC_HALOW >> 8);
|
||||
txbuf[13] = (uint8_t)(ETHERTYPE_MESHTASTIC_HALOW & 0xFF);
|
||||
memcpy(txbuf + sizeof(HaLowEthFrameHeader), &radioBuffer, encoded);
|
||||
|
||||
enum mmwlan_status st = mmwlan_tx(txbuf, sizeof(HaLowEthFrameHeader) + encoded);
|
||||
packetPool.release(p);
|
||||
sendingPacket = NULL;
|
||||
return (st == MMWLAN_SUCCESS) ? ERRNO_OK : ERRNO_UNKNOWN;
|
||||
#else
|
||||
packetPool.release(p);
|
||||
return ERRNO_DISABLED;
|
||||
#endif
|
||||
}
|
||||
|
||||
meshtastic_QueueStatus HaLowInterface::getQueueStatus()
|
||||
{
|
||||
meshtastic_QueueStatus qs = meshtastic_QueueStatus_init_zero;
|
||||
qs.free = 16;
|
||||
qs.maxlen = 16;
|
||||
return qs;
|
||||
}
|
||||
|
||||
uint32_t HaLowInterface::getPacketTime(uint32_t totalPacketLen, bool /*received*/)
|
||||
{
|
||||
// bytes * 8 bits / (HALOW_NOMINAL_KBPS * 1000 bits/sec) * 1000 ms/sec.
|
||||
// Floor to 1 ms so the slot-time math upstream never divides by zero.
|
||||
uint32_t ms = (totalPacketLen * 8u + HALOW_NOMINAL_KBPS - 1u) / HALOW_NOMINAL_KBPS;
|
||||
return ms ? ms : 1u;
|
||||
}
|
||||
|
||||
int32_t HaLowInterface::runOnce()
|
||||
{
|
||||
return 1000; // nothing to do until the SDK is wired in
|
||||
}
|
||||
|
||||
void HaLowInterface::onFrameReceived(const uint8_t *payload, size_t payload_len, int8_t rssi)
|
||||
{
|
||||
if (!payload || payload_len < sizeof(PacketHeader)) {
|
||||
return;
|
||||
}
|
||||
// Cap at our RadioBuffer size — anything larger is malformed for our wire
|
||||
// format and we drop it rather than corrupt memory.
|
||||
if (payload_len > sizeof(RadioBuffer)) {
|
||||
LOG_WARN("HaLow: rx %u > RadioBuffer, dropping", (unsigned)payload_len);
|
||||
return;
|
||||
}
|
||||
|
||||
meshtastic_MeshPacket *p = packetPool.allocZeroed();
|
||||
if (!p) {
|
||||
return;
|
||||
}
|
||||
|
||||
// Unpack the RadioBuffer into a MeshPacket (mirrors the LoRa RX decode).
|
||||
const PacketHeader *h = reinterpret_cast<const PacketHeader *>(payload);
|
||||
p->from = h->from;
|
||||
p->to = h->to;
|
||||
p->id = h->id;
|
||||
p->channel = h->channel;
|
||||
p->hop_limit = h->flags & PACKET_FLAGS_HOP_LIMIT_MASK;
|
||||
p->want_ack = !!(h->flags & PACKET_FLAGS_WANT_ACK_MASK);
|
||||
p->via_mqtt = !!(h->flags & PACKET_FLAGS_VIA_MQTT_MASK);
|
||||
p->hop_start = (h->flags & PACKET_FLAGS_HOP_START_MASK) >> PACKET_FLAGS_HOP_START_SHIFT;
|
||||
p->relay_node = h->relay_node;
|
||||
p->next_hop = h->next_hop;
|
||||
|
||||
size_t payload_only = payload_len - sizeof(PacketHeader);
|
||||
if (payload_only > sizeof(p->encrypted.bytes)) {
|
||||
packetPool.release(p);
|
||||
return;
|
||||
}
|
||||
memcpy(p->encrypted.bytes, payload + sizeof(PacketHeader), payload_only);
|
||||
p->encrypted.size = payload_only;
|
||||
p->which_payload_variant = meshtastic_MeshPacket_encrypted_tag;
|
||||
|
||||
// mmwlan's rx callback doesn't carry per-frame RSSI on this SDK version —
|
||||
// fall back to the connection-level RSSI for visibility in the phone UI.
|
||||
(void)rssi;
|
||||
int32_t link_rssi = mmwlan_get_rssi();
|
||||
p->rx_rssi = (link_rssi == INT32_MIN) ? 0 : (int8_t)link_rssi;
|
||||
p->rx_snr = 0;
|
||||
p->rx_time = getValidTime(RTCQualityFromNet);
|
||||
|
||||
deliverToReceiver(p);
|
||||
}
|
||||
|
||||
#endif // USE_HALOW_RADIO
|
||||
@@ -0,0 +1,56 @@
|
||||
#pragma once
|
||||
#ifdef USE_HALOW_RADIO
|
||||
|
||||
#include "RadioInterface.h"
|
||||
#include "concurrency/OSThread.h"
|
||||
|
||||
/**
|
||||
* HaLow (802.11ah) transport. Derives directly from RadioInterface because
|
||||
* RadioLib has no MM6108 driver and the model doesn't fit — mmwlan is a
|
||||
* frame-level API, not a register-level SPI interface.
|
||||
*
|
||||
* Frames go out as Ethernet payloads (broadcast MAC, EtherType 0x88B5) carrying
|
||||
* the same RadioBuffer the LoRa path builds via beginSending(), so the
|
||||
* Meshtastic wire format is unchanged.
|
||||
*
|
||||
* True peer-broadcast requires MAC-layer support that mm-iot-esp32 does not
|
||||
* currently expose (no 802.11s / IBSS / monitor mode). Until that gap closes,
|
||||
* the send path is a no-op and packets must travel over UDP multicast via the
|
||||
* existing UdpMulticastHandler path (HaLow operating as a STA against an AP).
|
||||
* See the plan for the SDK-side workstream.
|
||||
*/
|
||||
class HaLowInterface : public RadioInterface, private concurrency::OSThread
|
||||
{
|
||||
public:
|
||||
HaLowInterface();
|
||||
~HaLowInterface() override;
|
||||
|
||||
bool init() override;
|
||||
bool reconfigure() override;
|
||||
bool sleep() override;
|
||||
bool canSleep() override;
|
||||
|
||||
ErrorCode send(meshtastic_MeshPacket *p) override;
|
||||
meshtastic_QueueStatus getQueueStatus() override;
|
||||
uint32_t getPacketTime(uint32_t totalPacketLen, bool received = false) override;
|
||||
|
||||
protected:
|
||||
int32_t runOnce() override;
|
||||
|
||||
private:
|
||||
void onFrameReceived(const uint8_t *payload, size_t payload_len, int8_t rssi);
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
// Trampoline registered with mmwlan_register_rx_cb. The callback hands us
|
||||
// the 802.3 header and payload separately.
|
||||
static void rxTrampoline(uint8_t *header, unsigned header_len, uint8_t *payload, unsigned payload_len, void *arg);
|
||||
#endif
|
||||
|
||||
// Approximate bytes-per-millisecond at the configured channel width / MCS.
|
||||
// HaLow is 150 kbps to 32.5 Mbps depending on configuration — picking a
|
||||
// single value is fiction, but airtime accounting needs *something*, and
|
||||
// duty cycle isn't the constraint on HaLow that it is on LoRa.
|
||||
static constexpr uint32_t HALOW_NOMINAL_KBPS = 1000; // 1 Mbps, 2 MHz MCS3 ballpark
|
||||
};
|
||||
|
||||
#endif // USE_HALOW_RADIO
|
||||
@@ -80,7 +80,7 @@ static_assert(sizeof(meshtastic_NodeInfoLite) <= 130, "NodeInfoLite size increas
|
||||
#if defined(ARCH_STM32WL)
|
||||
#define MAX_NUM_NODES 10
|
||||
#elif defined(ARCH_NRF52)
|
||||
#define MAX_NUM_NODES 80
|
||||
#define MAX_NUM_NODES 150
|
||||
#elif defined(CONFIG_IDF_TARGET_ESP32S3)
|
||||
#include "Esp.h"
|
||||
static inline int get_max_num_nodes()
|
||||
|
||||
@@ -0,0 +1,53 @@
|
||||
#include "configuration.h"
|
||||
#ifdef USE_HALOW_WIFI
|
||||
|
||||
#include "HaLowWiFi.h"
|
||||
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
extern "C" {
|
||||
#include "mmwlan.h"
|
||||
}
|
||||
#endif
|
||||
|
||||
namespace halow
|
||||
{
|
||||
|
||||
HaLowWiFiClass HaLowWiFi;
|
||||
|
||||
void HaLowWiFiClass::begin(const char *ssid, const char *passphrase)
|
||||
{
|
||||
(void)ssid;
|
||||
(void)passphrase;
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
// Phase 1: mmwlan_sta_connect(ssid, passphrase, ...).
|
||||
#endif
|
||||
}
|
||||
|
||||
uint8_t HaLowWiFiClass::status()
|
||||
{
|
||||
#ifdef USE_MM_IOT_ESP32
|
||||
// Phase 1: translate mmwlan link state to the Arduino-WiFi-compat enum.
|
||||
return HALOW_WL_DISCONNECTED;
|
||||
#else
|
||||
return HALOW_WL_DISCONNECTED;
|
||||
#endif
|
||||
}
|
||||
|
||||
IPAddress HaLowWiFiClass::localIP()
|
||||
{
|
||||
return IPAddress(0, 0, 0, 0);
|
||||
}
|
||||
|
||||
String HaLowWiFiClass::macAddress()
|
||||
{
|
||||
return String("00:00:00:00:00:00");
|
||||
}
|
||||
|
||||
bool HaLowWiFiClass::isConnected()
|
||||
{
|
||||
return status() == HALOW_WL_CONNECTED;
|
||||
}
|
||||
|
||||
} // namespace halow
|
||||
|
||||
#endif // USE_HALOW_WIFI
|
||||
@@ -0,0 +1,47 @@
|
||||
#pragma once
|
||||
#ifdef USE_HALOW_WIFI
|
||||
|
||||
#include <IPAddress.h>
|
||||
#include <WString.h>
|
||||
#include <stdint.h>
|
||||
|
||||
// Subset of the Arduino WiFi API that WiFiAPClient.cpp and UdpMulticastHandler
|
||||
// touch, backed by Morse Micro mmwlan STA-mode association. Lets the existing
|
||||
// mesh-over-IP path ride HaLow with no changes to call sites — required while
|
||||
// the peer-broadcast HaLowInterface remains gated on SDK work.
|
||||
|
||||
namespace halow
|
||||
{
|
||||
|
||||
enum WiFiStatusCompat : uint8_t {
|
||||
HALOW_WL_IDLE_STATUS = 0,
|
||||
HALOW_WL_NO_SSID_AVAIL = 1,
|
||||
HALOW_WL_CONNECTED = 3,
|
||||
HALOW_WL_DISCONNECTED = 6,
|
||||
};
|
||||
|
||||
class HaLowWiFiClass
|
||||
{
|
||||
public:
|
||||
void begin(const char *ssid, const char *passphrase);
|
||||
uint8_t status();
|
||||
IPAddress localIP();
|
||||
String macAddress();
|
||||
bool isConnected();
|
||||
};
|
||||
|
||||
extern HaLowWiFiClass HaLowWiFi;
|
||||
|
||||
} // namespace halow
|
||||
|
||||
// When the HaLow variant is being built, redirect the Arduino WiFi handle
|
||||
// expected by call sites to the HaLow shim. Including this header in the
|
||||
// preprocessor-conditional places that currently #include <WiFi.h> is enough
|
||||
// to swap the implementation at build time.
|
||||
#define WiFi ::halow::HaLowWiFi
|
||||
#define WL_CONNECTED ::halow::HALOW_WL_CONNECTED
|
||||
#define WL_NO_SSID_AVAIL ::halow::HALOW_WL_NO_SSID_AVAIL
|
||||
#define WL_DISCONNECTED ::halow::HALOW_WL_DISCONNECTED
|
||||
#define WL_IDLE_STATUS ::halow::HALOW_WL_IDLE_STATUS
|
||||
|
||||
#endif // USE_HALOW_WIFI
|
||||
@@ -291,10 +291,8 @@ static int32_t reconnectWiFi()
|
||||
#endif
|
||||
return 1000; // check once per second
|
||||
} else {
|
||||
#ifdef ARCH_RP2040
|
||||
onNetworkConnected(); // will only do anything once
|
||||
#endif
|
||||
return 300000; // every 5 minutes
|
||||
onNetworkConnected(); // will only do anything once (guarded by APStartupComplete)
|
||||
return 300000; // every 5 minutes
|
||||
}
|
||||
}
|
||||
|
||||
@@ -343,9 +341,6 @@ bool initWifi()
|
||||
const char *wifiPsw = config.network.wifi_psk;
|
||||
|
||||
#ifndef ARCH_RP2040
|
||||
#if !MESHTASTIC_EXCLUDE_WEBSERVER
|
||||
createSSLCert(); // For WebServer
|
||||
#endif
|
||||
WiFi.persistent(false); // Disable flash storage for WiFi credentials
|
||||
#endif
|
||||
if (!*wifiPsw) // Treat empty password as no password
|
||||
@@ -370,6 +365,9 @@ bool initWifi()
|
||||
#endif
|
||||
}
|
||||
#ifdef ARCH_ESP32
|
||||
// Register WiFi event handler BEFORE createSSLCert() to prevent race condition:
|
||||
// Without this, WiFi can auto-reconnect during cert generation and fire GOT_IP
|
||||
// before the handler is registered, causing onNetworkConnected() to never run.
|
||||
WiFi.onEvent(WiFiEvent);
|
||||
WiFi.setAutoReconnect(true);
|
||||
WiFi.setSleep(false);
|
||||
@@ -391,6 +389,12 @@ bool initWifi()
|
||||
wifiDisconnectReason = info.wifi_sta_disconnected.reason;
|
||||
},
|
||||
WiFiEvent_t::ARDUINO_EVENT_WIFI_STA_DISCONNECTED);
|
||||
#endif
|
||||
|
||||
#ifndef ARCH_RP2040
|
||||
#if !MESHTASTIC_EXCLUDE_WEBSERVER
|
||||
createSSLCert(); // For WebServer - called after WiFi.onEvent() to avoid race condition
|
||||
#endif
|
||||
#endif
|
||||
LOG_DEBUG("JOINING WIFI soon: ssid=%s", wifiName);
|
||||
wifiReconnect = new Periodic("WifiConnect", reconnectWiFi);
|
||||
|
||||
@@ -4,6 +4,7 @@
|
||||
#include "GPS.h"
|
||||
#include "MeshService.h"
|
||||
#include "NodeDB.h"
|
||||
#include "PositionPrecision.h"
|
||||
#include "RTC.h"
|
||||
#include "Router.h"
|
||||
#include "TransmitHistory.h"
|
||||
@@ -107,13 +108,7 @@ bool PositionModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp, mes
|
||||
}
|
||||
|
||||
nodeDB->updatePosition(getFrom(&mp), p);
|
||||
if (channels.getByIndex(mp.channel).settings.has_module_settings) {
|
||||
precision = channels.getByIndex(mp.channel).settings.module_settings.position_precision;
|
||||
} else if (channels.getByIndex(mp.channel).role == meshtastic_Channel_Role_PRIMARY) {
|
||||
precision = 32;
|
||||
} else {
|
||||
precision = 0;
|
||||
}
|
||||
precision = getPositionPrecisionForChannel(mp.channel);
|
||||
|
||||
return false; // Let others look at this message also if they want
|
||||
}
|
||||
@@ -121,15 +116,12 @@ bool PositionModule::handleReceivedProtobuf(const meshtastic_MeshPacket &mp, mes
|
||||
void PositionModule::alterReceivedProtobuf(meshtastic_MeshPacket &mp, meshtastic_Position *p)
|
||||
{
|
||||
// Phone position packets need to be truncated to the channel precision
|
||||
if (isFromUs(&mp) && (precision < 32 && precision > 0)) {
|
||||
LOG_DEBUG("Truncate phone position to channel precision %i", precision);
|
||||
p->latitude_i = p->latitude_i & (UINT32_MAX << (32 - precision));
|
||||
p->longitude_i = p->longitude_i & (UINT32_MAX << (32 - precision));
|
||||
|
||||
// We want the imprecise position to be the middle of the possible location, not
|
||||
p->latitude_i += (1 << (31 - precision));
|
||||
p->longitude_i += (1 << (31 - precision));
|
||||
|
||||
if (isFromUs(&mp)) {
|
||||
if (precision == 0)
|
||||
LOG_DEBUG("Strip phone position due to channel precision 0");
|
||||
else if (precision < 32)
|
||||
LOG_DEBUG("Truncate phone position to channel precision %i", precision);
|
||||
applyPositionPrecision(*p, precision);
|
||||
mp.decoded.payload.size =
|
||||
pb_encode_to_bytes(mp.decoded.payload.bytes, sizeof(mp.decoded.payload.bytes), &meshtastic_Position_msg, p);
|
||||
}
|
||||
@@ -206,20 +198,11 @@ meshtastic_MeshPacket *PositionModule::allocPositionPacket()
|
||||
|
||||
// lat/lon are unconditionally included - IF AVAILABLE!
|
||||
LOG_DEBUG("Send location with precision %i", precision);
|
||||
if (precision < 32 && precision > 0) {
|
||||
p.latitude_i = localPosition.latitude_i & (UINT32_MAX << (32 - precision));
|
||||
p.longitude_i = localPosition.longitude_i & (UINT32_MAX << (32 - precision));
|
||||
|
||||
// We want the imprecise position to be the middle of the possible location, not
|
||||
p.latitude_i += (1 << (31 - precision));
|
||||
p.longitude_i += (1 << (31 - precision));
|
||||
} else {
|
||||
p.latitude_i = localPosition.latitude_i;
|
||||
p.longitude_i = localPosition.longitude_i;
|
||||
}
|
||||
p.precision_bits = precision;
|
||||
p.latitude_i = localPosition.latitude_i;
|
||||
p.longitude_i = localPosition.longitude_i;
|
||||
p.has_latitude_i = true;
|
||||
p.has_longitude_i = true;
|
||||
applyPositionPrecision(p, precision);
|
||||
// Always use NTP / GPS time if available
|
||||
if (getValidTime(RTCQualityNTP) > 0) {
|
||||
p.time = getValidTime(RTCQualityNTP);
|
||||
@@ -350,8 +333,7 @@ void PositionModule::sendOurPosition()
|
||||
// If we changed channels, ask everyone else for their latest info
|
||||
LOG_INFO("Send pos@%x:6 to mesh (wantReplies=%d)", localPosition.timestamp, requestReplies);
|
||||
for (uint8_t channelNum = 0; channelNum < 8; channelNum++) {
|
||||
if (channels.getByIndex(channelNum).settings.has_module_settings &&
|
||||
channels.getByIndex(channelNum).settings.module_settings.position_precision != 0) {
|
||||
if (getPositionPrecisionForChannel(channelNum) != 0) {
|
||||
sendOurPosition(NODENUM_BROADCAST, requestReplies, channelNum);
|
||||
return;
|
||||
}
|
||||
@@ -369,10 +351,8 @@ void PositionModule::sendOurPosition(NodeNum dest, bool wantReplies, uint8_t cha
|
||||
if (prevPacketId) // if we wrap around to zero, we'll simply fail to cancel in that rare case (no big deal)
|
||||
service->cancelSending(prevPacketId);
|
||||
|
||||
// Set's the class precision value for this particular packet
|
||||
if (channels.getByIndex(channel).settings.has_module_settings) {
|
||||
precision = channels.getByIndex(channel).settings.module_settings.position_precision;
|
||||
}
|
||||
// Set the class precision value for this particular packet.
|
||||
precision = getPositionPrecisionForChannel(channel);
|
||||
|
||||
meshtastic_MeshPacket *p = allocPositionPacket();
|
||||
if (p == nullptr) {
|
||||
|
||||
@@ -21,9 +21,6 @@ ProcessMessage TextMessageModule::handleReceived(const meshtastic_MeshPacket &mp
|
||||
textPacketList[textPacketListIndex] = mp.id;
|
||||
textPacketListIndex = (textPacketListIndex + 1) % TEXT_PACKET_LIST_SIZE;
|
||||
|
||||
// We only store/display messages destined for us.
|
||||
devicestate.rx_text_message = mp;
|
||||
devicestate.has_rx_text_message = true;
|
||||
IF_SCREEN(
|
||||
// Guard against running in MeshtasticUI or with no screen
|
||||
if (config.display.displaymode != meshtastic_Config_DisplayConfig_DisplayMode_COLOR) {
|
||||
@@ -59,4 +56,4 @@ bool TextMessageModule::recentlySeen(uint32_t id)
|
||||
}
|
||||
}
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user