2024-11-25 22:07:35 +08:00
|
|
|
# Refer to https://ast-grep.github.io/guide/rule-config.html for Rule Essentials
|
|
|
|
|
id: no-kconfig-in-hal-component
|
|
|
|
|
message: Don't use Kconfig macros in the hal component
|
|
|
|
|
severity: error # error, warning, info, hint
|
|
|
|
|
note: hal component should be able to deliver without 3rd party config system
|
|
|
|
|
language: C
|
|
|
|
|
files:
|
|
|
|
|
- "components/hal/**/*"
|
|
|
|
|
ignores:
|
|
|
|
|
# porting layer and test apps are allowed to use Kconfig macros
|
|
|
|
|
- "components/hal/platform_port/**/*"
|
|
|
|
|
- "components/hal/test_apps/**/*"
|
|
|
|
|
# the following files should be refactored to remove Kconfig macros
|
|
|
|
|
- "components/hal/adc_oneshot_hal.c"
|
2025-06-18 12:12:59 +08:00
|
|
|
- "components/hal/cache_hal.c"
|
2024-11-25 22:07:35 +08:00
|
|
|
- "components/hal/ecdsa_hal.c"
|
|
|
|
|
- "components/hal/mmu_hal.c"
|
|
|
|
|
- "components/hal/spi_flash_hal.c"
|
2025-04-27 15:57:46 +08:00
|
|
|
- "components/hal/twai_hal_sja1000.c"
|
2024-11-25 22:07:35 +08:00
|
|
|
- "components/hal/esp32/gpio_hal_workaround.c"
|
|
|
|
|
- "components/hal/esp32/include/hal/twai_ll.h"
|
|
|
|
|
- "components/hal/esp32/include/hal/uart_ll.h"
|
|
|
|
|
- "components/hal/include/hal/ecdsa_hal.h"
|
|
|
|
|
- "components/hal/include/hal/gpio_hal.h"
|
2024-08-15 19:22:13 +08:00
|
|
|
- "components/hal/include/hal/twai_types_deprecated.h"
|
2024-11-25 22:07:35 +08:00
|
|
|
rule:
|
|
|
|
|
any:
|
|
|
|
|
- kind: argument_list
|
|
|
|
|
has:
|
|
|
|
|
kind: identifier
|
|
|
|
|
pattern: $N
|
|
|
|
|
- kind: preproc_if
|
|
|
|
|
has:
|
|
|
|
|
field: condition
|
|
|
|
|
pattern: $M
|
|
|
|
|
constraints:
|
|
|
|
|
N:
|
|
|
|
|
regex: "^CONFIG"
|
|
|
|
|
M:
|
|
|
|
|
regex: "^CONFIG"
|
|
|
|
|
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
id: no-sdkconfig-include-in-hal-component
|
|
|
|
|
message: Don't include sdkconfig.h in the hal component
|
|
|
|
|
severity: error # error, warning, info, hint
|
|
|
|
|
note: hal component should be able to deliver without 3rd party config system
|
|
|
|
|
language: C
|
|
|
|
|
files:
|
|
|
|
|
- "components/hal/**/*"
|
|
|
|
|
ignores:
|
|
|
|
|
# porting layer and test apps are allowed to include sdkconfig.h
|
|
|
|
|
- "components/hal/platform_port/**/*"
|
|
|
|
|
- "components/hal/test_apps/**/*"
|
|
|
|
|
# the following files should be refactored to remove sdkconfig.h
|
|
|
|
|
- "components/hal/adc_oneshot_hal.c"
|
|
|
|
|
- "components/hal/cache_hal.c"
|
|
|
|
|
- "components/hal/mmu_hal.c"
|
2025-04-27 15:57:46 +08:00
|
|
|
- "components/hal/twai_hal_sja1000.c"
|
2024-11-25 22:07:35 +08:00
|
|
|
- "components/hal/include/hal/ecdsa_hal.h"
|
2024-08-15 19:22:13 +08:00
|
|
|
- "components/hal/include/hal/twai_types_deprecated.h"
|
2024-11-25 22:07:35 +08:00
|
|
|
rule:
|
|
|
|
|
kind: preproc_include
|
|
|
|
|
has:
|
|
|
|
|
field: path
|
|
|
|
|
pattern: $N
|
|
|
|
|
constraints:
|
|
|
|
|
N:
|
|
|
|
|
regex: '^["<]sdkconfig' # match "sdkconfig.h" or <sdkconfig.h>
|
|
|
|
|
fix: ''
|
