GeniMo - Genius Mouse driver - Kompilace a testování

11.2.2009 23:14 | Přečteno: 1876× | Linux | | poslední úprava: 12.2.2009 22:42

Stručný popis zakompilování ovladače do systému a hlavně popis debugovacích informací potřebných pro další vývoj a následné rozšiřování podporovaných zařízení.

Zdrojový kód

Zdrojáky spolu s přehledem aktuálně podporovaných myšítek budu udržovat v samostatném zápisku.

Předpoklady

Než se pustíme do samotné kompilace, je třeba mít v systému nainstalován kompilátor gcc, hlavičkové soubory pro jádro, na kterém hodláte ovladač testovat, a prográmek xev, který nám poslouží k testování. Záměrně neuvádím postup jejich instalace ani názvy balíčků, protože to závisí na konkrétní distribuci.

V následujícím textu budu rozlišovat příkazy zadávané běžným uživatel pomocí $ a "rootem" pomocí #. Přepnutí se na superuživatele, roota nebo použití sudo nechám na vás a zvyklostech distribuce.

Zdrojové soubory si stáhneme do stejného adresáře a už zbývá jen nažhavit oblíbený terminál a pustit se do práce. Jen dodám, že jsem vše testoval na jádru 2.6.26, ale použité mechanismy jsou v jádře už několik let, takže by neměli nastat komplikace.

Kompilace a instalace

Postupem času se vývoj jádra víc a víc zjednodušuje, proto nám stačí se přepnout do adresáře se zdrojáky a pustit na ně make:

$ cd /cesta/ke/stazenym/soborum/
$ make

Během mrknutí máme k dispozici jaderný modul genimo.ko, který se už nemůže dočkat, až rozhodí celý systém (ano, dělám si srandu). Jako root můžeme provést instalaci modulu:

# make install

Obdobným příkazem můžeme modul i odinstalovat:

# make uninstall

Těsně před použitím

Než začne driver plnit svou funkci je třeba připojit myš. Ještě než tak učiníme, je dobré ručně odebrat modul usbhid a to zvláště v případě, kdy jsme náš modul upravili, překompilovali a nainstalovali po několikáté (neptejte se proč).

# rmmod usbhid

nebo

#modprobe -r usbhid

Pokud jsme testovanou myš doposud používali je teď ten správný okamžik ji odpojit.

Testování

Připojíme testovanou myš a zatajíme dech. Pokud se při pohybu myši začne adekvátně hýbat i kurzor po obrazovce případně i levé a pravé tlačítko plní svou funkci, máme napůl vyhráno. Pro jistotu nebo jen ze zvědavosti se můžeme pomocí příkazu lsmod přesvědčit, že systém automaticky načetl moduly usbhid, evdev a samozřejmě genimo.

Spustíme program xev:

$ xev

přesuneme kurzor myši nad jeho okno a sledujeme v terminálu na pozadí, co se bude dít během mačkání tlačítek a vrtění kolečkem. Pokud možno během této fáze s myší vůbec nehýbeme, jinak nerozlišíme události tlačítek od událostí pohybu. Nás nejvíce zajímá číslo vyskytující se za slovem "button".

ButtonPress event, serial 30, synthetic NO, window 0x3400001,
    root 0x6b, subw 0x3400002, time 45078031, (45,28), root:(49,77),
    state 0x0, button 8, same_screen YES

Nereaguje-li program na všechna tlačítka, ještě není vše ztraceno. Ukončeme xev a nahlédněme do logů jádra.

Debugovací informace

Chceme-li vidět, co se děje v pozadí zadáme:

$ dmesg

Konec výstupu může vypadat například takto:

[42726.008042] usb 1-2: new low speed USB device using uhci_hcd and address 10
[42726.236513] usb 1-2: configuration #1 chosen from 1 choice
[42726.261373] usb 1-2: New USB device found, idVendor=0458, idProduct=0087
[42726.261390] usb 1-2: New USB device strings: Mfr=1, Product=2, SerialNumber=0
[42726.261398] usb 1-2: Product: Ergo Mouse
[42726.261404] usb 1-2: Manufacturer: Genius
[42726.461335] input: Genius Ergo 525V as /class/input/input19
[42726.465653] genimo: New mouse Genius Ergo 525V has been attached
[42726.465707] usbcore: registered new interface driver genimo
[42726.522560] usbcore: registered new interface driver hiddev
[42726.522613] usbcore: registered new interface driver usbhid
[42726.522620] usbhid: v2.6:USB HID core driver

Po odpojení přibude něco takového:

[46098.408074] usb 1-2: USB disconnect, address 10
[46098.428880] genimo: The mouse Genius Ergo 525V has been disconnected

Všechny zprávy začínají časovou značkou udávající počet sekund od zapnutí systému, následuje název subsystému nebo ovladače a za dvojtečkou spousta "užitečných" informací. Pokud se nechceme kochat tím, jak se náš driver vtírá do přízně usb a input subsystémů, použijeme raději:

$ dmesg | grep -i genimo

V případě, že některá tlačítka xev nenašel, nás budou zajímat řádky se surovými daty přímo z myši (i když zase až tak surová nebudou díky usb vrstvě), tedy oněch osm osmibitových šestnáctkových čísel .

Příklad dat pro stisk a uvolnění tlačítek v pořadí: levé, pravé, prostřední, kolečko nahoru, dolů, vlevo, vpravo a boční tlačítka přední, zadní a prostřední:

[45416.863314] genimo: Data:  01 01 00 00 00 00 00 00
[45417.103431] genimo: Data:  01 00 00 00 00 00 00 00
[45418.583240] genimo: Data:  01 02 00 00 00 00 00 00
[45418.767250] genimo: Data:  01 00 00 00 00 00 00 00
[45425.743341] genimo: Data:  01 04 00 00 00 00 00 00
[45426.135397] genimo: Data:  01 00 00 00 00 00 00 00
[45456.879347] genimo: Data:  01 00 00 00 01 00 00 00
[45459.007424] genimo: Data:  01 00 00 00 FF 00 00 00
[45462.463320] genimo: Data:  01 00 00 00 00 FF 00 00
[45464.303428] genimo: Data:  01 00 00 00 00 01 00 00
[45469.623380] genimo: Data:  01 00 00 00 00 00 01 00
[45469.831363] genimo: Data:  01 00 00 00 00 00 00 00
[45471.111436] genimo: Data:  01 00 00 00 00 00 02 00
[45471.287325] genimo: Data:  01 00 00 00 00 00 00 00
[45472.503429] genimo: Data:  01 00 00 00 00 00 04 00
[45472.711425] genimo: Data:  01 00 00 00 00 00 00 00

Pro přehlednost se tato data se vypisují jen pro tlačítka a ne pro pohyb. Snažte se vypozorovat jaká data posílá které tlačítko. Až na to přijdete, vše pokud možno přehledně přidejte do diskuze a možná už v příští verzi ovladače bude mít vaše myš plnou podporu.

Snad jen letmý popis významu jednotlivých bajtů, který jsem odpozoroval u mé myšky. První bajt je vždy 01. Druhý bajt obsahuje informace o stisknutém "hlavním" tlačítku, sedmý bajt nápodobně pro tlačítka boční případně další, co jsou "nadstandard". Každý z těchto dvou bajtů je schopen rozlišit osm různých tlačítek, tedy sem by měla směřovat vaše pozornost pokud máte jiné tlačítka než já nebo jich máte více a nefungují. Třetí bajt obsahuje relativní změnu pozice v X-ové ose, čtvrtý bajt v Y-ové ose. V logu jsou vždy nulové, protože se data zapisují jen když je myš v klidu kvůli přehlednosti. Pátý bajt odráží relativní změnu během vertikálního scrollování a šestý bajt pro horizontální scrollování. Poslední bajt je v mém případě nevyužitý a tedy nulový.

Poslední zajímavost je, že některá tlačítka posílají data jak při stisku, tak i při uvolnění, zatím co jiná jen při stisku. Sem patří např. naklápění kolečka, které dokonce posílá data opakovaně, dokud tlačítko neuvolníme.

Nepodporované myšky

Není váš hlodavec v seznamu podporovaných zařízení? Nechce se vám čekat až se v něm objeví? Pomoc je snadná - úprava zdrojáku! Stačí přidat tzv. product ID do "tabulky" genimo_id_table na začátku souboru genimo.c. Vendor ID je vždy 0x0458 tedy Genius neboli KYE Systems Corporation. Chceme-li, aby systém vypisoval i přesné jméno myšky můžeme přidat záznam do struktury genimo_name_table o pár řádků níže. Číslo před zadávaným jménem je stejné product ID, které jsme před chvílí přidali do předchozí tabulky. Nyní stačí změny překompilovat, nainstalovat, odpojit myš, odebrat dva moduly a znovu myš připojit - prostě výše popsaný postup.

Závěrem

Snad vás popis debugovacích informací neodradil od pokusů a doufám, že vytvořený kód najde spoustu spokojených uživatelů. V přístím zápisku bych rád stručně shrnul své pokusy a zkušenosti s konfigurací X serveru a přiřazení konkrétních akcí "přebytečným" tlačítkům.

Upozornění

Jelikož je ovladač v podobě jaderného modulu, je nezbytné jej opětovně překompilovat po každé aktualizaci jádra.

       

Komentáře

[David Watzke]

Nejde mi to zkompilovat, proměnný HID_QUIRK_IGNORE* asi zmizely z jádra či co.

dave@amd64 ~/compile/genimo-001 $ make
make -C /lib/modules/2.6.29-rc4/build M=/home/dave/compile/genimo-001 modules
make[1]: Entering directory `/media/btrfs/kernels/linux-2.6.29-rc4'
  CC [M]  /home/dave/compile/genimo-001/genimo.o
/home/dave/compile/genimo-001/genimo.c: In function 'genimo_irq':
/home/dave/compile/genimo-001/genimo.c:138: error: implicit declaration of function 'info'
/home/dave/compile/genimo-001/genimo.c: In function 'genimo_probe':
/home/dave/compile/genimo-001/genimo.c:211: error: 'HID_QUIRK_IGNORE' undeclared (first use in this function)
/home/dave/compile/genimo-001/genimo.c:211: error: (Each undeclared identifier is reported only once
/home/dave/compile/genimo-001/genimo.c:211: error: for each function it appears in.)
/home/dave/compile/genimo-001/genimo.c:211: error: 'HID_QUIRK_IGNORE_MOUSE' undeclared (first use in this function)
make[2]: *** [/home/dave/compile/genimo-001/genimo.o] Error 1
make[1]: *** [_module_/home/dave/compile/genimo-001] Error 2
make[1]: Leaving directory `/media/btrfs/kernels/linux-2.6.29-rc4'
make: *** [all] Error 2
dave@amd64 ~/compile/genimo-001 $ uname -a
Linux amd64 2.6.29-rc4 #1 SMP PREEMPT Sun Feb 8 22:46:50 CET 2009 x86_64 AMD Athlon(tm) 64 X2 Dual Core Processor 4200+ AuthenticAMD GNU/Linux

[T.O.M.]

Vypadá to tak. Zkus celou část vyhodit - nahraď CONFIG_USB_HID nulou. Stejně si nejsem moc jistý k čemu to slouží. Nechal jsem to tam jen proto, že to bylo v šabloně

[David Watzke]

Je tam ještě ten trabl s makrem info(), který taky vyhodili. Podle .29-rc1 changelogu se místo toho má používat dev_info(), ale nevím jak.

[T.O.M.]

V tomto případě je řešení jednoduché. Nahradit "info(" za staré dobré "printk(KERN_INFO " (na konci je mezera)

Nemáš možnost to vyzkoušet na starším jádru? Nechce se mi teď hrát s integrací do poslední verze jádra, když zatím ani nevím, jestli je driver schopný zvládnout i jiné myšky než moji

[David Watzke]

Takhle už se to zkompiluje. Starší jádro nahazovat nechci, ale koukám že budu muset zkompilovat usbhid jako modul, protože to očividně jinak nefunguje. Modul se načte, po připojení myši je v dmesg

input: KYE NAVIGATOR 535 as /class/input/input5
generic-usb 0003:0458:006A.0004: input: USB HID v1.11 Device [KYE NAVIGATOR 535] on usb-0000:00:02.0-1/input0
input: KYE NAVIGATOR 535 as /class/input/input6
generic-usb 0003:0458:006A.0005: input: USB HID v1.11 Keyboard [KYE NAVIGATOR 535] on usb-0000:00:02.0-1/input1

ale chová se to furt stejně a xev nic nevypisuje pro extra tlačítka, ani v dmesg nic není, takže hádám, že se to ani nepoužívá... Takže na to mrknu jindy.

[T.O.M.]

Zajímave je už to, že se ti opravdu hlásí myš jako dvě zařízení. Na to pravděpodobně driver reagovat nebude. Nicméně podle tvého výstupu to vypadá, že se myši ujal usb subsystém a ne genimo driver. Překompilovávat usbhid jako modul asi nemusíš. Podle mých testů stačí genimo jednou nainstalovat odebrat modul usbhid nebo restartovat komp s připojenou myší. Pak stačí jen reinstalace. Ale kdo ví. V každé další verzi jádra je spousta změn a ty jsi hned tři verze napřed...

Mimochodem popřidával jsem do článku výstupy jednotlivých příkazů z testovacího stroje. Zkus je srovnat s tvým systémem.

[David Watzke]

Jo a mimochodem: v Makefile chybí vytvoření adresáře /lib/modules/$(uname -r)/tom/

[T.O.M.]

Máš pravdu, ten adresář už mám vytvořený hodně dlouho. Opraveno.

[Rax]

U moji mysli Genius Navigator 335, ktera ma jenom jedno tlacidlo navic se u tohoto tlacitka jsou zpravy jadra jenom same nuly.

[38543.172393] genimo: Data: 00 00 00 00 00 00 00 00 [38543.380388] genimo: Data: 00 00 00 00 00 00 00 00