TLE92466ED Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Namespaces | Macros | Functions
tle92466ed_kconfig.hpp File Reference

Optional ESP-IDF layer: a Config built from the CONFIG_TLE92466ED_* Kconfig options. More...

#include "tle92466ed_types.hpp"

Go to the source code of this file.

Namespaces

namespace  tle92466ed
 The TLE92466ED driver: everything it declares lives here; internals in detail.
 

Macros

#define CONFIG_TLE92466ED_WATCHDOG_TIMEOUT_MS   100
 
#define CONFIG_TLE92466ED_EXTERNAL_CLOCK_KHZ   0
 
#define CONFIG_TLE92466ED_INIT_TIMEOUT_US   10000
 
#define CONFIG_TLE92466ED_MAX_RETRIES   2
 

Functions

constexpr Config tle92466ed::KconfigDefaults () noexcept
 The configuration menuconfig selected, on top of the datasheet defaults.
 

Detailed Description

Optional ESP-IDF layer: a Config built from the CONFIG_TLE92466ED_* Kconfig options.

Include this header only where you want menuconfig to choose the defaults; the driver never includes it and no driver signature depends on it. Under ESP-IDF the values come from sdkconfig.h. Without Kconfig every option falls back to the datasheet default, so KconfigDefaults() equals Config{}.

Kconfig writes a bool option set to "n" as an absent macro, so every bool option here is named for the change from the reset value (CONFIG_TLE92466ED_VIO_3V3, CONFIG_TLE92466ED_CRC_CHECK_DISABLE, CONFIG_TLE92466ED_SPI_WATCHDOG): absent means the reset value in both cases. Channels are not Kconfig options: declare them in code.

One configuration per program: the inline function below depends on the CONFIG_ macros, so every translation unit of one program must see the same values (ESP-IDF has one sdkconfig.h per build; each host test is its own program). No driver or library header includes this one (handbook KB-CPP20-018).

Macro Definition Documentation

◆ CONFIG_TLE92466ED_EXTERNAL_CLOCK_KHZ

#define CONFIG_TLE92466ED_EXTERNAL_CLOCK_KHZ   0

External clock in kHz when Kconfig does not set it: 0, the internal oscillator.

◆ CONFIG_TLE92466ED_INIT_TIMEOUT_US

#define CONFIG_TLE92466ED_INIT_TIMEOUT_US   10000

INIT_DONE timeout in microseconds when Kconfig does not set it: Config{}.init_timeout_us.

◆ CONFIG_TLE92466ED_MAX_RETRIES

#define CONFIG_TLE92466ED_MAX_RETRIES   2

Read retries when Kconfig does not set it: Config{}.max_retries.

◆ CONFIG_TLE92466ED_WATCHDOG_TIMEOUT_MS

#define CONFIG_TLE92466ED_WATCHDOG_TIMEOUT_MS   100

SPI watchdog timeout in milliseconds when Kconfig does not set it.