Skip to content

Figures

Every figure on this site is drawn by a Python module from facts extracted from the code, so it is rebuilt, not redrawn, when the code changes. CI runs kokeb-docs figures --check and fails when a committed figure no longer matches the code. Each figure below lists the files it is drawn from.

Inside the TMC5160A

Block diagram of the TMC5160A: its function blocks, how they connect and which package pins reach each block.Block diagram of the TMC5160A: its function blocks, how they connect and which package pins reach each block.
Inside the TMC5160A
Figure description and sources

The TMC5160A's function blocks inside its outline. Arrows between blocks carry signals or data in the direction they point (both ways where they have two heads). The package pins stand on the left and right edges with their numbers, each wired to the block it reaches.

Drawn from: docs/hardware.yml; inc/tmc5160_spi_interface.hpp; inc/tmc5160_types.hpp; inc/tmc5160_uart_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

TMC5160A: SPI application

Schematic of the TMC5160A spi application: the chip with U2 MCU, U3 Power bridge and sense resistors, C1 capacitor 22 nF, C2 capacitor 100 nF, C3 capacitor 2.2 µF, C4 capacitor 2.2 µF, C5 capacitor 470 nF, C6 capacitor 100 nF, C7 capacitor 100 nF, R1 resistor 2.2 Ω, R2 resistor 4.7 kΩ; the MCU wires carry the port hooks GpioGet(InputPin::Diag0), GpioSet(CtrlPin::DrvEnn), Transfer().Schematic of the TMC5160A spi application: the chip with U2 MCU, U3 Power bridge and sense resistors, C1 capacitor 22 nF, C2 capacitor 100 nF, C3 capacitor 2.2 µF, C4 capacitor 2.2 µF, C5 capacitor 470 nF, C6 capacitor 100 nF, C7 capacitor 100 nF, R1 resistor 2.2 Ω, R2 resistor 4.7 kΩ; the MCU wires carry the port hooks GpioGet(InputPin::Diag0), GpioSet(CtrlPin::DrvEnn), Transfer().
TMC5160A: SPI application
Figure description and sources

A schematic. The MCU is on the left, each of its pins level with the chip pin it connects to; above each wire is the hook of the driver's port that drives or reads it. Supply pins point up to their supply and decoupling, ground pins down. Pins on the right carry the loads and the pins tied to a supply or ground; a cross marks a pin left open. A dot is a junction; wires that cross without a dot are not connected.

Drawn from: docs/hardware.yml; inc/tmc5160_spi_interface.hpp; inc/tmc5160_types.hpp; inc/tmc5160_uart_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

TMC5160A: UART chain of two nodes

Schematic of the TMC5160A uart chain of two nodes: the chip with U2 MCU, U3 TMC5160 node 2 (supply and ground as node 1), R1 resistor 1 kΩ, C1 capacitor 100 nF; the MCU wires carry the port hooks GpioGet(InputPin::Diag1), GpioSet(CtrlPin::DrvEnn), Transfer().Schematic of the TMC5160A uart chain of two nodes: the chip with U2 MCU, U3 TMC5160 node 2 (supply and ground as node 1), R1 resistor 1 kΩ, C1 capacitor 100 nF; the MCU wires carry the port hooks GpioGet(InputPin::Diag1), GpioSet(CtrlPin::DrvEnn), Transfer().
TMC5160A: UART chain of two nodes
Figure description and sources

A schematic. The MCU is on the left, each of its pins level with the chip pin it connects to; above each wire is the hook of the driver's port that drives or reads it. Supply pins point up to their supply and decoupling, ground pins down. Pins on the right carry the loads and the pins tied to a supply or ground; a cross marks a pin left open. A dot is a junction; wires that cross without a dot are not connected.

Drawn from: docs/hardware.yml; inc/tmc5160_spi_interface.hpp; inc/tmc5160_types.hpp; inc/tmc5160_uart_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

TMC5160A package, TQFP-48

Outline of the TMC5160A in TQFP-48 drawn to scale from above: body 7.0 x 7.0 x 1.2 mm, pitch 0.5 mm, 48 pins and an exposed pad.Outline of the TMC5160A in TQFP-48 drawn to scale from above: body 7.0 x 7.0 x 1.2 mm, pitch 0.5 mm, 48 pins and an exposed pad.
TMC5160A package, TQFP-48
Figure description and sources

The TMC5160A package seen from the top and, when the height is known, from the side, drawn to scale: 7.0 x 7.0 x 1.2 mm. The arrows carry the datasheet's dimensions, the dot marks pin 1 and the pads are numbered counter-clockwise from it, coloured by the pin's electrical type (legend below). Pads sit centred on each side at the stated pitch; the datasheet's land pattern is the reference for a board.

Drawn from: docs/hardware.yml; inc/tmc5160_spi_interface.hpp; inc/tmc5160_types.hpp; inc/tmc5160_uart_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

TMC5160A pinout, TQFP-48

Pinout of the TMC5160A in TQFP-48, top view: 48 pins and an exposed pad, each with its name, its electrical type as a colour and the driver hook that uses it.Pinout of the TMC5160A in TQFP-48, top view: 48 pins and an exposed pad, each with its name, its electrical type as a colour and the driver hook that uses it.
TMC5160A pinout, TQFP-48
Figure description and sources

The TMC5160A seen from the top, in its TQFP-48 package. Pin 1 is marked by the dot; the numbers run counter-clockwise from it. Each pad is coloured by the pin's electrical type (legend below). Next to it is the pin's name and, in mono, the hook of the driver's port that drives or reads it; a pin without a hook is not used by the driver. The dashed square is the exposed pad.

Drawn from: docs/hardware.yml; inc/tmc5160_spi_interface.hpp; inc/tmc5160_types.hpp; inc/tmc5160_uart_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

The layers, one of them yours

Layer diagram: your application calls the TMC5160 core, which sends register reads and writes through the SPI port contract to the port class you write, which drives the chip; the core and the contract are the same on every MCU.Layer diagram: your application calls the TMC5160 core, which sends register reads and writes through the SPI port contract to the port class you write, which drives the chip; the core and the contract are the same on every MCU.
The layers, one of them yours
Figure description and sources

Top to bottom, each arrow is a call. Your application calls one object, whose public calls are listed from the umbrella header in inc/. The core turns each call into register reads and writes and hands them to the port contract (the CRTP base in inc/*_interface.hpp), which forwards them, at compile time, to the hooks of the port class you write; your port moves the bytes on the bus. The notes on the right say which layers stay the same on every MCU and which one you write. A library without a port contract has only the first two layers.

Drawn from: inc/tmc5160.hpp public calls; inc/tmc5160_spi_interface.hpp SpiInterface; figure module docs/diagrams/figures/driver-layers.py.

Figure module: docs/diagrams/figures/driver-layers.py

Drawn from:

One call through the layers

One call through the layers: your code calls SetCurrent(800, 240), the core exchanges frames with the chip through your port and returns the result to your code.One call through the layers: your code calls SetCurrent(800, 240), the core exchanges frames with the chip through your port and returns the result to your code.
One call through the layers
Figure description and sources

Participants, left to right: Your code, TMC5160 and Your port. The steps run from top to bottom. Your code sends SetCurrent(800, 240) to TMC5160. A note over TMC5160 says: PlanCurrent: ceiling, sense bound, scaler. TMC5160 sends Transfer(write GLOBALSCALER) to Your port. Your port returns true, status byte to TMC5160. A note over TMC5160 says: reset flag? return UnexpectedReset. TMC5160 sends Transfer(write IHOLD_IRUN) to Your port. Your port returns true, status byte to TMC5160. TMC5160 returns Result to Your code.

Drawn from: docs/model/one-call-through-the-layers.seq.yml.

Hardware description: docs/model/one-call-through-the-layers.seq.yml

Drawn from: