HF-Core Platform 0.1.0-dev
Hardware-Agnostic Handler Layer & RTOS Utilities for HardFOC
Loading...
Searching...
No Matches
Tmc9660CtrlPins Struct Reference

Shared helper holding the four TMC9660 host-side control pin references. More...

#include <Tmc9660Handler.h>

Public Member Functions

BaseGpio & get (tmc9660::TMC9660CtrlPin pin) noexcept
 Resolve a TMC9660CtrlPin enum to the corresponding BaseGpio reference.
 
const BaseGpio & get (tmc9660::TMC9660CtrlPin pin) const noexcept
 Resolve a TMC9660CtrlPin enum (const).
 

Public Attributes

BaseGpio & rst
 RST control pin GPIO (not owned).
 
BaseGpio & drv_en
 DRV_EN control pin GPIO (not owned).
 
BaseGpio & faultn
 FAULTN status pin GPIO (not owned).
 
BaseGpio & wake
 WAKE control pin GPIO (not owned).
 

Detailed Description

Shared helper holding the four TMC9660 host-side control pin references.

Both HalSpiTmc9660Comm and HalUartTmc9660Comm require the same four GPIO control pins (RST, DRV_EN, FAULTN, WAKE) and share identical pin-resolution logic. This struct consolidates the four GPIO references and pin lookup into a single definition, eliminating code duplication across communication adapters.

Note
None of the GPIO references are owned by this struct.

Member Function Documentation

◆ get() [1/2]

const BaseGpio & Tmc9660CtrlPins::get ( tmc9660::TMC9660CtrlPin pin) const
inlinenoexcept

Resolve a TMC9660CtrlPin enum (const).

◆ get() [2/2]

BaseGpio & Tmc9660CtrlPins::get ( tmc9660::TMC9660CtrlPin pin)
inlinenoexcept

Resolve a TMC9660CtrlPin enum to the corresponding BaseGpio reference.

Member Data Documentation

◆ drv_en

BaseGpio& Tmc9660CtrlPins::drv_en

DRV_EN control pin GPIO (not owned).

◆ faultn

BaseGpio& Tmc9660CtrlPins::faultn

FAULTN status pin GPIO (not owned).

◆ rst

BaseGpio& Tmc9660CtrlPins::rst

RST control pin GPIO (not owned).

◆ wake

BaseGpio& Tmc9660CtrlPins::wake

WAKE control pin GPIO (not owned).


The documentation for this struct was generated from the following file: