---
# The vendor documents this driver was written against (handbook ADR-0019), and where the driver relies on them.
# Never commit a PDF: `sha256` identifies the exact file that was used, so a reader can confirm they hold the same
# revision. `pdf` is a stable direct link when the vendor publishes one (page links are built from it, adding
# `page_offset` when the printed page numbers differ from the PDF's); otherwise readers download from `url`.
#
# The README card, docs/datasheet.md and the "Datasheet" box on each page are generated from this file by
# tools/docs/generators/datasheet.py (`kokeb-docs gen`).
documents:
  - id: ds
    vendor: Infineon
    title: TLE92466ED
    kind: Datasheet
    number: IFX-ntz1491827137291
    revision: "1.2"
    date: 2022-02-01
    url: https://www.infineon.com/part/TLE92466ED
    pdf: https://www.infineon.com/assets/row/public/documents/10/49/infineon-tle92466ed-datasheet-en.pdf
    page_offset: 0
    sha256: ba74787f32e3c92452b68f28f980ac6877ea36c476c9b2e7bd187e9ddeeb027f

# One row per thing the driver takes from a document: the datasheet's own section names and printed page
# numbers, the driver API that implements it, and the docs pages that explain it (file names in docs/).
topics:
  - topic: Pins, RESN, EN, DRV0/DRV1 and FAULTN
    doc: ds
    section: 2 Pin configuration; 4.2.3 TDS_I/O Pins
    page: 7
    driver: "`CtrlPin`, `GpioSignal`, `SetDrivePin()`, `ReadFaultPin()`"
    docs: [hardware, porting, quickstart]
  - topic: Functional range of VDD, VBAT, VIO, f_SYS and f_PWM
    doc: ds
    section: 3.2.1 Functional range, Table 6
    page: 11
    driver: "`kMinSystemClockHz`, `kMaxSystemClockHz`, `kMinPwmHz`, `kMaxPwmHz`, `Validate()`"
    docs: [hardware, configuration]
  - topic: Supplies, VIO_SEL and the power-on reset
    doc: ds
    section: 4.1.1 TDS_Power Supply
    page: 14
    driver: "`Config::vio`, `GetStartupFaults()`"
    docs: [hardware, configuration, troubleshooting]
  - topic: Voltage monitoring and the VBAT thresholds
    doc: ds
    section: 4.1.2 TDS_Voltage monitoring; Equation 1
    page: 14
    driver: "`Config::vbat_uv_code`, `vbat_ov_code`, `VbatThresholdCode()`, `ReadSupply()`"
    docs: [configuration, troubleshooting]
  - topic: Reset times t_RESN and t_POR
    doc: ds
    section: 4.1.3 Electrical characteristics power supply, Table 9
    page: 15
    driver: "`EnsureInitialized()`, `kResetReleaseUs`, `kPowerOnResetUs`, `kResetPulseUs`"
    docs: [hardware, limitations]
  - topic: Clock source, PLL dividers and INIT_DONE
    doc: ds
    section: 4.2.1 TDS_Clock; Equations 2, 3; Table 10
    page: 16
    driver: "`Config::clock`, `external_clock_khz`, `PllRefDiv()`, `PllFbDiv()`, `SystemClockHz()`"
    docs: [configuration, hardware]
  - topic: Clock watchdog
    doc: ds
    section: 4.2.2 TDS_Clock Watchdog
    page: 17
    driver: "`Config::clock_watchdog`"
    docs: [configuration]
  - topic: Reset State, Config Mode, Mission Mode and Critical Fault
    doc: ds
    section: 4.3.1 TDS_IC Operation states; Figure 4
    page: 19
    driver: "`EnterMissionMode()`, `EnterConfigMode()`, `Error::MissionBlocked`, `Error::CriticalFault`"
    docs: [architecture, api-guide, troubleshooting]
  - topic: Channel modes and the measurement period
    doc: ds
    section: 4.4 Channel modes
    page: 21
    driver: "`ChannelMode`, `ConfigureChannel()`"
    docs: [configuration, api-guide]
  - topic: Parallel channel pairs
    doc: ds
    section: 4.5.2 TDS_Parallel channel operation
    page: 22
    driver: "`ParallelPair`, `Config::parallel`, `SetParallel()`, `Error::WrongState`"
    docs: [configuration, api-guide]
  - topic: Slew rate
    doc: ds
    section: 4.5.3 Electrical characteristics power stages, Table 13
    page: 23
    driver: "`SlewRate`, `ChannelConfig::slew`"
    docs: [configuration]
  - topic: Integrating current controller, Autolimit and the PWM frequency controller
    doc: ds
    section: 4.6.2 Integrating Current Controller (ICC); Equations 4, 5
    page: 24
    driver: "`IccConfig`, `PwmFrequencyHz()`, `CurrentControlChannel()`"
    docs: [configuration, api-guide]
  - topic: Setpoint range and accuracy
    doc: ds
    section: 4.6.3 Electrical characteristics current control, Table 14
    page: 28
    driver: "`SetCurrent()`, `kMaxSetpointUa`, `kMaxSetpointWithDitherUa`, `kMaxParallelSetpointUa`"
    docs: [api-guide, limitations]
  - topic: Dither waveform and its update
    doc: ds
    section: 4.7.1 TDS_Dither configuration; 4.7.2 TDS_Dither parameter update; Equations 6 to 9
    page: 29
    driver: "`DitherConfig`, `SetDither()`, `DitherAmplitudeUa()`"
    docs: [configuration, api-guide]
  - topic: Direct drive via SPI on-time and DRV pins
    doc: ds
    section: 4.8.1 TDS_Direct Drive; Equation 10
    page: 32
    driver: "`ChannelMode::DirectDriveSpi`, `DirectDriveDrv0`, `DirectDriveDrv1`, `SetDrivePin()`"
    docs: [configuration, hardware]
  - topic: ON-state and OFF-state diagnosis
    doc: ds
    section: 4.9.1 TDS_Overview; Figures 14, 15
    page: 32
    driver: "`DiagConfig`, `OffStateDiag`, `ChannelConfig::loaded`"
    docs: [api-guide, configuration, limitations]
  - topic: Open load or short to ground, thresholds and warning
    doc: ds
    section: 4.9.2 TDS_Open Load/Short to Ground (OLSG); 4.9.3 TDS_OLSG Warning
    page: 34
    driver: "`DiagConfig::ol_fixed`, `ol_relative_eighths`, `olsg_warning`, `ChannelFaults::olsg`"
    docs: [api-guide, troubleshooting]
  - topic: Overcurrent and the OFF-state overcurrent check
    doc: ds
    section: 4.9.6 TDS_Overcurrent (OC); Equation 17
    page: 38
    driver: "`StartOvercurrentCheck()`, `ClearChannelFaults()`, `kMaxOcOnTimeUs`"
    docs: [api-guide]
  - topic: Register and OTP ECC, the self-test
    doc: ds
    section: 4.9.7 TDS_Register/OTP ECC; 4.9.8 TDS_Built in Self Test (BIST)
    page: 39
    driver: "`RunBist()`, `GlobalFault::OtpVirgin`, `Error::DeviceFault`"
    docs: [api-guide, troubleshooting]
  - topic: Average current, duty cycle and VBAT feedback
    doc: ds
    section: 4.10.2 TDS_Average feedback values; Equations 18 to 22
    page: 41
    driver: "`ReadChannelFeedback()`, `ChannelFeedback`, `Error::NotReady`"
    docs: [api-guide, troubleshooting]
  - topic: Fast feedback and the sequence counters
    doc: ds
    section: 4.10.3 TDS_Fast measurement feedback; 4.10.4 TDS_Sequence counter
    page: 42
    driver: "`FastFeedback`, `ChannelFeedback::period_count`, `quad_count`"
    docs: [configuration]
  - topic: Feedback freeze and update
    doc: ds
    section: 4.10.5 TDS_Update/Freeze Mechanism; Figure 22
    page: 43
    driver: "`ReadChannelFeedback()`"
    docs: [api-guide, architecture]
  - topic: Overtemperature and the temperature feedback
    doc: ds
    section: 4.11.1 TDS_Overtemperature protection; Equation 32
    page: 45
    driver: "`ReadSupply()`, `ChannelFaults::overtemperature`, `GlobalFault::CentralOtError`"
    docs: [api-guide]
  - topic: SPI frame, mode and CRC-8 SAE J1850
    doc: ds
    section: 5.1.1 TDS_General information; 5.1.2 TDS_Cyclic redundancy check (CRC)
    page: 47
    driver: "`kSpiMode`, `kMsbFirst`, `kFrameBytes`, `reg::FrameCrc()`, `Config::crc_check`, `Error::Crc`"
    docs: [hardware, porting, architecture]
  - topic: SPI timing
    doc: ds
    section: 5.1.4 Electrical characteristics SPI interface, Table 18
    page: 48
    driver: "`kMaxClockHz`, `kMinCsHighNs`, `kCsSetupNs`, `kCsHoldNs`"
    docs: [hardware, porting]
  - topic: The reply pipeline, frames and reply status
    doc: ds
    section: 5.2.1 TDS_Data flow; 5.2.3 SPI frame definition
    page: 50
    driver: "`detail::Transport`, `detail::DecodeReply()`, `Error::ReplyMismatch`, `FrameRejected`, `NoDevice`"
    docs: [architecture, contract, troubleshooting]
  - topic: SPI watchdog
    doc: ds
    section: 5.2.2 TDS_SPI watchdog; Equation 33
    page: 50
    driver: "`Config::spi_watchdog`, `watchdog_reload`, `ReloadWatchdog()`, `WatchdogReloadCode()`"
    docs: [api-guide, configuration, limitations]
  - topic: Central registers, reset values and bit types
    doc: ds
    section: 5.3.1 Overview of Register Types; 5.3.2 Central registers
    page: 54
    driver: "`inc/tle92466ed_registers.hpp`, `Config{}`, `ReadRegister()`, `ClearFaults()`"
    docs: [configuration, architecture, limitations]
  - topic: Identity, ICVID and CHIPID
    doc: ds
    section: 5.3.2.19 Version Register; 5.3.2.24 Unique Chip Identification Number Register 0
    page: 75
    driver: "`kManufacturerId`, `GetIcVersion()`, `ReadChipId()`, `Error::DeviceIdMismatch`"
    docs: [hardware, troubleshooting]
  - topic: FB_STAT, the status summary
    doc: ds
    section: 5.3.2.21 Feedback Status Register
    page: 77
    driver: "`ReadStatus()`, `DeviceStatus`, `Error::UnexpectedReset`"
    docs: [api-guide, architecture]
  - topic: Channel registers and their bank addresses
    doc: ds
    section: 5.3.3 Channel registers, Tables 24 and 25
    page: 85
    driver: "`reg::kChannelBase`, `ConfigureChannel()`"
    docs: [configuration, architecture]
  - topic: Application circuit
    doc: ds
    section: 6.1 TDS_Application information; Figure 26
    page: 105
    driver: "none: board design"
    docs: [hardware]
