stm32_timers_dma_burst_read(9)

πŸ“¦ version 7.3.1, in nixpkgs unstable

πŸ’… stm32_timers_dma_burst_read(9) β€” the kernel API manual, bestie edition πŸŽ€

okay so this is a page from the Kernel API Manual (yes, that manual) and it's about stm32_timers_dma_burst_read, which is literally the function you call when you want the STM32 timers to spill their register tea straight into memory via DMA. no CPU babysitting, no cap. ✨


🌸 NAME 🌸

stm32_timers_dma_burst_read β€” Read from timers registers using DMA. πŸ’–

like, that's it, that's the whole vibe: DMA reads the timer registers for you.


πŸ¦‹ SYNOPSIS πŸ¦‹

int stm32_timers_dma_burst_read (struct device *dev , u32 *buf , enum
       stm32_timers_dmas id , u32 reg , unsigned int num_reg , unsigned int
       bursts , unsigned long tmo_ms );

she takes seven arguments and returns an int. main character energy, honestly. πŸ‘‘


✨ ARGUMENTS ✨

  • dev β€” reference to the stm32_timers MFD device. like, the parent device, the one who actually knows the timers. 🫢
  • buf β€” the DMA'able destination buffer. key word DMA'able β€” it has to be memory the DMA engine can actually touch, so don't be cute and pass it something random. πŸ™ˆ
  • id β€” the stm32_timers_dmas event identifier. the options are ch[1..4], up, trig or com. pick your fighter. πŸ’…
  • reg β€” the registers start offset for DMA to read from (like CCRx for capture). aka where the reading starts. πŸ“
  • num_reg β€” number of registers to read upon each DMA request, starting at reg. so it's a stretch, not a single. 🌈
  • bursts β€” number of bursts to read (e.g. like two for pwm period capture). yes, bursts plural, she's greedy in the best way. πŸ”₯
  • tmo_ms β€” timeout, in milliseconds. the "girl wrap it up" timer. ⏰

πŸ’œ DESCRIPTION πŸ’œ

Read from STM32 timers registers using DMA on a single event. πŸŽ€

that's the whole bit β€” one event fires, DMA goes and scoops up the register values into your buffer, and you get to keep your CPU cycles for yourself. slay.

ngl the manpage keeps this section short, so I'm not gonna invent lore. it's one event, it's DMA, it reads registers. periodt. πŸ’€

πŸ” SEE ALSO πŸ”

  • Kernel file ./drivers/mfd/stm32-timers.c β€” go read the source, bestie, that's where all the lore lives. πŸ“–

and that's the page!! πŸ’– source lives under ./drivers/mfd, and the version/date stamp says October 2026 β€” so yeah, this manual is from the future, iykyk. 🧚 ⭐ 🌸

stm32_timers_dma_burst_read(9) β€” fly high, DMA queen. πŸ¦‹πŸ‘‘

πŸ“¦ where this page comes from