Jaderné noviny - Video4Linux2 - 2: registrace a open()

14. 11. 2006 | Robert Krátký | Jaderné noviny | 4676×

Druhý díl série o psaní ovladačů pro jaderné rozhraní Video4Linux2. Tato část se bude věnovat celkové struktuře Video4Linux ovladače a procesu registrace zařízení.

Článek by teoreticky patřil do Jaderné noviny - 18. 10. 2006, ale kvůli jeho délce jsem jej zařadil samostatně.

Pokud jste propásli úvodní díl, začněte u něj.

Než začneme, připomenu dva zdroje informací, které jsou neocenitelnou pomůckou každého, kdo pracuje s video ovladači:

• Specifikace V4L2 API. Tento dokument rozebírá API z uživatelského hlediska, ale V4L2 ovladače toto API z velké míry přímo implementují. Takže je většina struktur stejná a sémantika V4L2 volání je přehledně představena. Vytiskněte si kopii (šetřte stromy vynecháním FDL) a nechte si ji někde po ruce.
• Ovladač "vivi", který najdete ve zdrojácích jádra jako drivers/media/video/vivi.c. Jde o virtuální ovladač, protože generuje testovací vzory a nepracuje s žádným hardwarem. Jako takový slouží coby relativně jasné znázornění toho, jak by měly být V4L2 ovladače psány.

Každý V4L2 ovladač musí obsahovat tento hlavičkový soubor:

    #include <linux/videodev2.h>

Je tam většina potřebných informací. Až se však budete, coby autor ovladače, probírat hlavičkami, podívejte se také na include/media/v4l2-dev.h, kde je definováno mnoho struktur, se kterými budete pracovat.

Video ovladač bude mít pravděpodobně části, které se budou týkat sběrnic PCI nebo USB (například); této části ovladače se tady příliš věnovat nebudeme. Často je nutné interní rozhraní i2c, které později v této sérii probírat budeme. Pak rozhraní k subsystému V4L2. To je postaveno kolem struct video_device, které reprezentuje V4L2 zařízení. Probrání všeho, co patří do této struktury, bude námětem několika článků; teď přijde jen obecný přehled.

Pole name v struct video_device je název typu zařízení; tak se bude objevovat v logu jaderných hlášení a v sysfs. Název je většinou stejný jako jméno ovladače.

Dvě pole popisují, jaký druh zařízení je reprezentován. První (type) vypadá jako pozůstatek z Video4Linux1 API; může mít čtyři hodnoty:

• VFL_TYPE_GRABBER značí zařízení pro zachytávání snímků - včetně kamer, tunerů a podobně.
• VFL_TYPE_VBI je pro zařízení, která stahují informace během video blanking intervalu.
• VFL_TYPE_RADIO pro rádiová zařízení.
• VFL_TYPE_VTX pro videotextová zařízení.

Pokud vaše zařízení zvládá více než jednu z jmenovaných funkcí, mělo by být pro každou podporovanou funkci registrováno samostatné V4L2 zařízení. Ve V4L2 však může být po kterémkoliv z registrovaných zařízení požadováno, aby fungovalo v jednom z podporovaných režimů. Znamená to, že pro V4L2 je potřeba pouze jediné zařízení, ale kvůli kompatibilitě se starším API Video4Linux musí být pro každou funkci registrováno samostatné zařízení.

Druhé pole se nazývá type2 a je to bitmask podrobněji popisující schopnosti zařízení. Může obsahovat kterékoliv z následujících hodnot:

• VID_TYPE_CAPTURE: zařízení umí zachytávat video data.
• VID_TYPE_TUNER: umí naladit různé frekvence.
• VID_TYPE_TELETEXT: umí číst teletextová data.
• VID_TYPE_OVERLAY: umí zobrazit video data pomocí overlay přímo na framebuffer.
• VID_TYPE_CHROMAKEY: speciální druh overlay, kdy jsou video data zobrazena pouze tam, kde podkladový framebuffer obsahuje pixely určité barvy.
• VID_TYPE_CLIPPING: umí seříznout overlay data.
• VID_TYPE_FRAMERAM: používá paměť v zařízení framebufferu.
• VID_TYPE_SCALES: umí škálovat video data.
• VID_TYPE_MONOCHROME: je to monochromní zařízení.
• VID_TYPE_SUBCAPTURE: umí zachytávat části obrázku.
• VID_TYPE_MPEG_DECODER: umí dekódovat MPEG streamy.
• VID_TYPE_MPEG_ENCODER: umí enkódovat MPEG streamy.
• VID_TYPE_MJPEG_DECODER: umí dekódovat MJPEG streamy.
• VID_TYPE_MJPEG_ENCODER: umí enkódovat MJPEG streamy.

Další pole, které je inicializováno všemi V4L2 ovladači, je minor, což je požadované minor číslo zařízení. Pole bude většinou nastaveno na -1, což způsobí, že se subsystém Video4Linux pokusí číslo alokovat při registraci.

Dále tři jasně vymezené sady ukazatelů na funkce, které jsou v struct video_device. První, který obsahuje jedinou funkci, je metoda release(). Pokud zařízení postrádá funkci release(), bude si jádro stěžovat (neposlušní programátoři jsou odkázání na článek na LWN). Funkce release() je důležitá: z různých důvodů se může stát, že odkazy na strukturu video_device přetrvají dlouho po té, co poslední video aplikace uzavřela svůj popisovač souboru. Tyto odkazy mohou zůstat i po odregistrování zařízení. Proto není bezpečné strukturu uvolnit před zavoláním metody release(). Často tedy tato funkce obsahuje prosté zavolání kfree().

Struktura video_device v sobě obsahuje strukturu file_operations s běžnými ukazateli na funkce. Video ovladače vždy potřebují operace open() a release(); podotýkám, že tento release() je volán při každém uzavření zařízení, nikoliv při uvolnění, jako je to v případě výše popisované funkce se stejným názvem. Často budou potřeba metody read() nebo write() - podle toho, jestli zařízení provádí vstup nebo výstup; pro streamovací zařízení však existují jiné způsoby přenosu dat. Většina zařízení, která pracují se streamováním video dat, bude muset implementovat poll() a mmap(). A každé V4l2 zařízení potřebuje metodu ioctl() - ale je možné použít video_ioctl2(), kterou poskytuje subsystém V4L2.

Třetí sada metod je uložena přímo v struktuře video_device a tvoří jádro V4L2 API. Funkcí je několik desítek a starají se o různé konfigurační operace, streamování I/O atd.

A konečně ještě jedno pole, které se vyplatí znát už na začátku: debug. Nastavením na V4L2_DEBUG_IOCTL a/nebo V4L2_DEBUG_IOCTL_ARG zajistíte slušné množství debugovacího výstupu, který může zmatenému programátorovi pomoci zjistit, proč si ovladač nerozumí s aplikací.

Registrace video zařízení

Jakmile je nastavena struktura video_device, měla by být registrována pomocí

    int video_register_device(struct video_device *vfd, int type, int nr);

vfd je struktura zařízení, type je stejná hodnota jako v poli type a nr je zase požadované minor číslo (nebo -1 pro dynamickou alokaci). Návratová hodnota by měla být nula; záporný chybový kód značí, že došlo k závažné chybě. Jako vždy je dobré pamatovat na to, že metody zařízení mohou být volány okamžitě po registraci; nevolejte video_register_device(), dokud není vše připraveno.

Odregistrovat zařízení lze pomocí

    void video_unregister_device(struct video_device *vfd);

Další díl se bude věnovat implementaci některých těchto metod.

open() a release()

Každé V4L2 zařízení bude potřebovat metodu open() s obvyklým prototypem:

    int (*open)(struct inode *inode, struct file *filp);

První věc, kterou metoda open() obyčejně dělá, je nalezení interního zařízení odpovídajícího dané inode; to je provedeno s pomocí minor čísla uloženého v inode. Lze provést trochu inicializace; může to být také vhodná chvíle k zapnutí zařízení - pokud má možnost vypínání.

Specifikace V4L2 definuje několik konvencí, které se teď hodí zmínit. Jednou z nich je to, že všechna V4L2 zařízení mohou mít kdykoliv otevřeno více popisovačů souborů. Účelem je umožnit jedné aplikaci zobrazování (nebo generování) video dat, zatímco jiná například upravuje ovládací hodnoty. Takže ačkoliv mohou být určité V4L2 operace (především zapisování a čtení video dat) rezervovány pro jediný popisovač souboru, zařízení jako celek by mělo podporovat více otevřených popisovačů.

Další konvence říká, že by metoda open() obecně neměla provádět změny provozních parametrů právě nastavených v hardwaru. Mělo by být možné spustit z příkazové řádky program, který kameru nakonfiguruje podle určité sady požadovaných hodnot (rozlišení, formát videa atd.), a pak spustit zcela nezávislou aplikaci, která z kamery například zachytí obrázek. To by nefungovalo, kdyby bylo mezitím nastavení resetováno. V4L2 ovladač by se tedy měl snažit zachovat stávající nastavení, dokud ho aplikace výslovně nezruší.

Metoda release() zajišťuje veškerý potřebný úklid. Protože mohou mít video zařízení otevřeno několik popisovačů souborů, release() musí snížit počítadlo a provést kontrolu, než udělá něco zásadního. Pokud byl právě uzavřený popisovač souboru využíván k přenosu dat, může být nutné vypnout DMA engine a provést další úklid.

Další díl série se pustí do dlouhého procesu dotazování se na možnosti zařízení a konfigurace provozních režimů. Zůstaňte s námi.

       

Komentáře

[Filip Jirsák]

s/setřte/šetřte/

[Robert Krátký]

Dík.