rawmidi: doc - fix the framing / read mode section

Follow the previous changes and describe the current API.

Signed-off-by: Jaroslav Kysela <perex@perex.cz>

diff --git a/src/rawmidi/rawmidi.c b/src/rawmidi/rawmidi.c
index 31845e6f1ddd8f5b06a1d4923cd080d8c0e930d8..9fab63f1e2285b1e288c8bb3b80edde8aead41b3 100644 (file)
--- a/src/rawmidi/rawmidi.c
+++ b/src/rawmidi/rawmidi.c
@@ -118,14 +118,14 @@ hw:soundwave,1,2
 hw:DEV=1,CARD=soundwave,SUBDEV=2
 \endcode
 
-\section rawmidi_framing Framing of rawmidi data
+\section read_mode Read mode
 
-Optionally, incoming rawmidi bytes can be put inside a frame of type snd_rawmidi_framing_tstamp_t.
-The main current benefit is that can enable in-kernel timestamping of incoming bytes, and that
-timestamp is likely to be more precise than what userspace can offer.
+Optionally, incoming rawmidi bytes can be marked with timestamps. The library hides
+the kernel implementation (linux kernel 5.14+) and exports
+the \link ::snd_rawmidi_tread() \endlink  function which returns the
+midi bytes marked with the identical timestamp in one iteration.
 
-Tstamp type framing requires a kernel >= 5.14 and a buffer size that is a multiple of
-sizeof(snd_rawmidi_framing_tstamp_t). It is only available on input streams.
+The timestamping is available only on input streams.
 
 \section rawmidi_examples Examples