tmag5273 3.6.10

Platform-agnostic no_std driver for the TI TMAG5273 3-axis Hall-effect sensor
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

# tmag5273 — Build, test, and quality targets
#
# Library targets run on the host (no hardware needed).
# Field-test crates (HIL, monitor, size harness) live in a sibling repo:
# https://github.com/coffiot/tmag5273-field-tests

.DEFAULT_GOAL := help

# --------------------------------------------------------------------------- #
#	Config
# --------------------------------------------------------------------------- #

# Espressif Rust toolchain — only used by the cross-compile check below.
CARGO_ESP ?= cargo +esp

# Source the Espressif environment if the export script exists.
# This adds xtensa-esp32s3-elf-gcc and other ESP tools to PATH.
ESP_ENV := . $${HOME}/export-esp.sh 2>/dev/null;

# --------------------------------------------------------------------------- #
#	ANSI formatting
# --------------------------------------------------------------------------- #

BOLD := \033[1m
CYAN := \033[36m
GREEN := \033[32m
MAGENTA := \033[35m
RESET := \033[0m

# --------------------------------------------------------------------------- #
#	Phony declarations
# --------------------------------------------------------------------------- #

.PHONY: help test test-crc test-defmt test-minimal lint check \
        build doc coverage verify clean

# --------------------------------------------------------------------------- #
#	Library targets (no hardware)
# --------------------------------------------------------------------------- #

##@ Library (host — no hardware required)

test: ## Run unit tests (~370, all features)
	cargo test --all-features

test-crc: ## Run unit tests with CRC feature only
	cargo test --features crc

test-defmt: ## Run unit tests with defmt feature only
	cargo test --features defmt

test-minimal: ## Verify feature gates are additive (no default features)
	cargo test --no-default-features

lint: ## Run clippy on the library crate
	cargo clippy --all-features -- -D warnings

# --------------------------------------------------------------------------- #
#	Compilation checks (no hardware)
# --------------------------------------------------------------------------- #

##@ Compilation checks (no hardware)

check: ## Verify driver compiles on ARM, RISC-V and Xtensa (no std/alloc)
	@printf "$(BOLD)Checking driver (thumbv7em-none-eabihf)...$(RESET)\n"
	cargo check --target thumbv7em-none-eabihf
	@printf "$(BOLD)Checking driver (riscv32imc-unknown-none-elf)...$(RESET)\n"
	cargo check --target riscv32imc-unknown-none-elf
	@printf "$(BOLD)Checking driver (xtensa-esp32s3-none-elf)...$(RESET)\n"
	@$(ESP_ENV) $(CARGO_ESP) check --target xtensa-esp32s3-none-elf -Zbuild-std=core

# --------------------------------------------------------------------------- #
#	Build targets
# --------------------------------------------------------------------------- #

##@ Build

build: ## Build driver (all features, host target)
	cargo build --all-features

# --------------------------------------------------------------------------- #
#	Unified verify target
# --------------------------------------------------------------------------- #

##@ Quality

verify: test lint check ## Run tests + lint + cross-compile checks
	@printf "\n$(BOLD)$(GREEN)════════════════════════════════════════$(RESET)\n"
	@printf "$(BOLD)$(GREEN)  All verification passed.$(RESET)\n"
	@printf "$(BOLD)$(GREEN)════════════════════════════════════════$(RESET)\n\n"

doc: ## Build docs locally with feature annotations
	cargo doc --all-features --open

coverage: ## Generate test coverage report (lcov + HTML)
	@mkdir -p coverage
	cargo llvm-cov --all-features --lcov --output-path coverage/lcov.info
	cargo llvm-cov --all-features --html --output-dir coverage/html
	@printf "\n$(BOLD)Coverage report:$(RESET)\n"
	@printf "  lcov:  coverage/lcov.info\n"
	@printf "  HTML:  coverage/html/html/index.html\n\n"

# --------------------------------------------------------------------------- #
#	Housekeeping
# --------------------------------------------------------------------------- #

##@ Housekeeping

clean: ## Remove all build artifacts
	cargo clean

# --------------------------------------------------------------------------- #
#	Help
# --------------------------------------------------------------------------- #

help: ## Show this help message
	@awk 'BEGIN { \
		FS = ":.*##"; \
		printf "\n$(BOLD)tmag5273 Build System$(RESET)\n\n"; \
		printf "$(CYAN)Usage:$(RESET) make <target>\n\n" \
	} \
	/^##@/ { \
		if (section != "") printf "\n"; \
		section = substr($$0, 5); \
		printf "$(BOLD)$(MAGENTA)%s$(RESET)\n", section \
	} \
	/^[a-zA-Z][a-zA-Z0-9_-]*:.*##/ { \
		printf "  $(CYAN)%-30s$(RESET) %s\n", $$1, $$2 \
	}' $(MAKEFILE_LIST)
	@printf "\n"