About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Documentation / video4linux / cx2341x / fw-dma.txt

Custom Search

Based on kernel version 4.7.2. Page generated on 2016-08-22 22:48 EST.

1	This page describes the structures and procedures used by the cx2341x DMA
2	engine.
4	Introduction
5	============
7	The cx2341x PCI interface is busmaster capable. This means it has a DMA
8	engine to efficiently transfer large volumes of data between the card and main
9	memory without requiring help from a CPU. Like most hardware, it must operate
10	on contiguous physical memory. This is difficult to come by in large quantities
11	on virtual memory machines.
13	Therefore, it also supports a technique called "scatter-gather". The card can
14	transfer multiple buffers in one operation. Instead of allocating one large
15	contiguous buffer, the driver can allocate several smaller buffers.
17	In practice, I've seen the average transfer to be roughly 80K, but transfers
18	above 128K were not uncommon, particularly at startup. The 128K figure is
19	important, because that is the largest block that the kernel can normally
20	allocate. Even still, 128K blocks are hard to come by, so the driver writer is
21	urged to choose a smaller block size and learn the scatter-gather technique.
23	Mailbox #10 is reserved for DMA transfer information.
25	Note: the hardware expects little-endian data ('intel format').
27	Flow
28	====
30	This section describes, in general, the order of events when handling DMA
31	transfers. Detailed information follows this section.
33	- The card raises the Encoder interrupt.
34	- The driver reads the transfer type, offset and size from Mailbox #10.
35	- The driver constructs the scatter-gather array from enough free dma buffers
36	  to cover the size.
37	- The driver schedules the DMA transfer via the ScheduleDMAtoHost API call.
38	- The card raises the DMA Complete interrupt.
39	- The driver checks the DMA status register for any errors.
40	- The driver post-processes the newly transferred buffers.
42	NOTE! It is possible that the Encoder and DMA Complete interrupts get raised
43	simultaneously. (End of the last, start of the next, etc.)
45	Mailbox #10
46	===========
48	The Flags, Command, Return Value and Timeout fields are ignored.
50	Name:       Mailbox #10
51	Results[0]: Type: 0: MPEG.
52	Results[1]: Offset: The position relative to the card's memory space.
53	Results[2]: Size: The exact number of bytes to transfer.
55	My speculation is that since the StartCapture API has a capture type of "RAW"
56	available, that the type field will have other values that correspond to YUV
57	and PCM data.
59	Scatter-Gather Array
60	====================
62	The scatter-gather array is a contiguously allocated block of memory that
63	tells the card the source and destination of each data-block to transfer.
64	Card "addresses" are derived from the offset supplied by Mailbox #10. Host
65	addresses are the physical memory location of the target DMA buffer.
67	Each S-G array element is a struct of three 32-bit words. The first word is
68	the source address, the second is the destination address. Both take up the
69	entire 32 bits. The lowest 18 bits of the third word is the transfer byte
70	count. The high-bit of the third word is the "last" flag. The last-flag tells
71	the card to raise the DMA_DONE interrupt. From hard personal experience, if
72	you forget to set this bit, the card will still "work" but the stream will
73	most likely get corrupted.
75	The transfer count must be a multiple of 256. Therefore, the driver will need
76	to track how much data in the target buffer is valid and deal with it
77	accordingly.
79	Array Element:
81	- 32-bit Source Address
82	- 32-bit Destination Address
83	- 14-bit reserved (high bit is the last flag)
84	- 18-bit byte count
86	DMA Transfer Status
87	===================
89	Register 0x0004 holds the DMA Transfer Status:
91	Bit
92	0   read completed
93	1   write completed
94	2   DMA read error
95	3   DMA write error
96	4   Scatter-Gather array error
Hide Line Numbers
About Kernel Documentation Linux Kernel Contact Linux Resources Linux Blog

Information is copyright its respective author. All material is available from the Linux Kernel Source distributed under a GPL License. This page is provided as a free service by mjmwired.net.