Treiber PCI-Subsystem

Transkript

1 Treiber PCI-Subsystem Dr.-Ing. Matthias Sand Lehrstuhl für Informatik 3 (Rechnerarchitektur) Friedrich-Alexander-Universität Erlangen-Nürnberg WS 2010/2011 Treiber PCI-Subsystem 1/

2 Übersicht Inhalt: Geräte(er)kennung, Initialisierung und Deinitialisierung, Ressourcen ermitteln und anfordern, Hardwarezugriff, Interrupts. Treiber PCI-Subsystem 2/

3 Geräte(er)kennung Typischer Ablauf 1 Modul-Initialisierung meldet den Treiber mit seiner Probeund Remove-Funktion beim PCI-Subsystem an, 2 PCI-Subsystem erkennt Hardware, findet über Herstellerund Gerätekennung zuständigen Treiber und ruft Probe-Funktion auf, 3 Probe-Funktion fordert Ressourcen an, initialisiert Hardware, 4 Treiber-Funktionen greifen auf Hardware zu, 5 Modul-Deinitialisierung meldet den Treiber beim PCI-Subsystem ab, 6 PCI-Subsystem ruft bei Entfernen des Geräts oder Treibers die Remove-Funktion auf, 7 Remove-Funktion gibt Ressourcen frei. Treiber PCI-Subsystem 3/

4 API: pci_register_driver pci_register_driver #i n c l u d e <l i n u x / p c i. h> i n t p c i _ r e g i s t e r _ d r i v e r ( s t r u c t p c i _ d r i v e r d r i v e r ) ; Registriert den durch die Struktur driver beschriebenen Treiber beim PCI-Subsystem, ist keine Hardware vorhanden und unterstützt der Kernel kein Hotplugging, wird der Treiber sofort wieder abgemeldet, wird typischerweise in der module_init-funktion aufgerufen, Rückgabewert: 0 bei Erfolg, negativer Fehlercode sonst (typischerweise -ENODEV). Treiber PCI-Subsystem 4/

5 API: pci_unregister_driver pci_unregister_driver #i n c l u d e <l i n u x / p c i. h> void p c i _ u n r e g i s t e r _ d r i v e r ( s t r u c t p c i _ d r i v e r d r i v e r ) ; Meldet den durch die Struktur driver beschriebenen Treiber beim PCI-Subsystem ab, wird typischerweise in der module_exit-funktion aufgerufen, das PCI-Subsystem ruft in der Folge die remove-funktion auf. Treiber PCI-Subsystem 5/

6 PCI-Treiberstruktur Aus <linux/pci.h>... s t r u c t p c i _ d r i v e r {... char name ; const s t r u c t p c i _ d e v i c e _ i d i d _ t a b l e ; i n t ( probe ) ( s t r u c t pci_dev dev, const s t r u c t p c i _ d e v i c e _ i d i d ) ; void ( remove ) ( s t r u c t pci_dev dev ) ;... } ; Treiber PCI-Subsystem 6/

7 PCI-ID-Struktur Aus <linux/mod_devicetable.h>... s t r u c t p c i _ d e v i c e _ i d { u32 vendor, d e v i c e ; u32 subvendor, s u b d e v i c e ; u32 c l a s s, class_mask ; k e r n e l _ u l o n g _ t d r i v e r _ d a t a ; } ; Treiber PCI-Subsystem 7/

8 PCI-ID-Struktur (2) MODULE_DEVICE_TABLE #i n c l u d e <l i n u x / module. h> MODULE_DEVICE_TABLE( subsystem, t a b e l l e ) ; Ergänzt die Meta-Information des erzeugten Moduls um Informationen, für welche Geräte der Treiber geeignet ist, subsystem bezeichnet das Subsystem, dem das Gerät angehört (pci, usb, isapnp,...), tabelle zeigt auf eine Subsystemspezifische Geräte-ID-Tabelle (bei PCI also eine vom Typ struct pci_device_id *). Treiber PCI-Subsystem 8/

9 PCI-Strukturen Beispiel s t a t i c const s t r u c t p c i _ d e v i c e _ i d d e v i n i t d a t a dhwk_pci_ids [ ] = { { 0 x10b5, / vendor / 0 x9056, / d e v i c e / PCI_ANY_ID, / subvendor / PCI_ANY_ID, / s u b d e v i c e / 0, 0, 0 }, { 0, } / Ende des A r r a y s / } ; s t a t i c s t r u c t p c i _ d r i v e r dhwk_driver = {. name = "dhwk",. i d _ t a b l e = dhwk_pci_ids,. probe = dhwk_probe,. remove = devexit_p ( dhwk_remove ), } ; Treiber PCI-Subsystem 9/

10 PCI-Strukturen (2) Beispiel (Fort.)... MODULE_DEVICE_TABLE( pci, dhwk_pci_ids ) ;... s t a t i c i n t i n i t dhwk_init ( void ) { i f ( r e g i s t e r _ c h r d e v (240, "DHWK",& f o p s ) == 0) { i f ( p c i _ r e g i s t e r _ d r i v e r (& dhwk_driver ) < 0) { u n r e g i s t e r _ c h r d e v (240, "DHWK" ) ; r e t u r n EIO ; } r e t u r n 0 ; } r e t u r n EIO ; }... m o d u l e _ i n i t ( dhwk_init ) ; Treiber PCI-Subsystem 10/

11 PCI-Funktionen probe probe i n t d r i v e r _ p r o b e ( s t r u c t pci_dev dev, const s t r u c t p c i _ d e v i c e _ i d i d ) ; Wird aufgerufen, wenn das PCI-Subsystem eine Hardware-Komponente vom registrierten Typ gefunden hat, sollte der Sektion devinit zugeordnet werden, die Implementation muss ggf. testen, welche Variante/Version der Hardware vorliegt, Ressourcen reservieren, treiber- und gerätespezifische Initialisierungen durchführen, sie braucht keinen Hardware-Probe im eigentlichen Sinne durchzuführen, Rückgabewert: 0 bei Erfolg, negativer Fehlercode sonst. Treiber PCI-Subsystem 11/

12 PCI-Gerätestruktur Aus <linux/pci.h>... s t r u c t pci_dev {... unsigned s h o r t vendor ; unsigned s h o r t d e v i c e ; s t r u c t d e v i c e dev ; i n t c f g _ s i z e ; unsigned i n t i r q ; s t r u c t r e s o u r c e r e s o u r c e [DEVICE_COUNT_RESOURCE ] ;... } ; Treiber PCI-Subsystem 12/

13 Device-Struktur driver_data void dev_get_drvdata ( s t r u c t d e v i c e dev ) ; void dev_set_drvdata ( s t r u c t d e v i c e dev, void data ) ; Dient zum Manipulieren treiberspezifischer Daten in der Device-Struktur (dev in struct pci_dev), der direkte Zugriff auf driver_data ist nicht mehr möglich. Treiber PCI-Subsystem 13/

14 PCI-Funktionen remove remove void d r i v e r _ r e m o v e ( s t r u c t pci_dev dev ) ; Gegenstück zu probe, die Implementation muss ggf. die Hardware deinitialisieren und alle reservierten Ressourcen freigeben, sollte der Sektion devexit zugeordnet werden. Treiber PCI-Subsystem 14/

15 Ressourcen anfordern PCI-Subsystem reserviert bereits für alle Geräte, die es findet, die in ihrem Config-Space angeforderten Speicher- und IO-Ressourcen. Aber... Bevor ein Treiber auf IO- oder Speicher-IO-Bereiche zugreifen darf, muss er sie beim betreffenden Subsystem anfordern. Treiber PCI-Subsystem 15/

16 Ressourcen anfordern pci_request_regions pci_request_regions #i n c l u d e <l i n u x / p c i. h> i n t p c i _ r e q u e s t _ r e g i o n s ( s t r u c t pci_dev pdev, const char res_name ) ; Reserviert alle IO- und Speicher-Ressourcen des Geräts pdev unter dem Namen res_name, nach erfolgreicher Registrierung erscheint ein entsprechender Eintrag in /proc/ioports und/oder /proc/iomem, Rückgabewert: 0 bei Erfolg, -EBUSY bei Fehler. Treiber PCI-Subsystem 16/

17 Ressourcen anfordern request_region request_region #i n c l u d e <l i n u x / i o p o r t. h> s t r u c t r e s o u r c e r e q u e s t _ r e g i o n ( unsigned long from, unsigned long l e n g t h, const char name ) ; Fordert den Bereich der Länge length ab der Adresse from im IO-Port-Bereich unter dem Namen name an, nach erfolgreicher Registrierung erscheint ein entsprechender Eintrag in /proc/ioports, Rückgabewert: Adresse der resource-struktur bei Erfolg, NULL bei Fehler. Treiber PCI-Subsystem 17/

18 Ressourcen anfordern request_mem_region request_mem_region #i n c l u d e <l i n u x / i o p o r t. h> s t r u c t r e s o u r c e request_mem_region ( unsigned long from, unsigned long l e n g t h, const char name ) ; Fordert den Bereich der Länge length ab der Adresse from im Speicher-IO-Bereich unter dem Namen name an, nach erfolgreicher Registrierung erscheint ein entsprechender Eintrag in /proc/iomem, Rückgabewert: Adresse der resource-struktur bei Erfolg, NULL bei Fehler. Treiber PCI-Subsystem 18/

19 Ressourcen ermitteln PCI-Ressourcen-Makros Zum bequemen Zugriff auf die IO-Ressourcen des PCI-Config- Space stehen eine Reihe von Makros zur Verfügung, deren wichtigste im Folgenden vorgestellt werden. pci_resource_flags #i n c l u d e <l i n u x / p c i. h> unsigned long p c i _ r e s o u r c e _ f l a g s ( s t r u c t pci_dev dev, i n t bar ) ; Gibt die Flags des durch bar bezeichneten Basis-Adress-Registers des PCI-Gerätes dev zurück, Rückgabewert: Disjunktion über Flags aus <linux/ioport.h>, u.a. IORESOURCE_IO IO-Adressbereich, IORESOURCE_MEM Speicheradressbereich. Treiber PCI-Subsystem 19/

20 Ressourcen ermitteln (2) pci_resource_start und _end #i n c l u d e <l i n u x / p c i. h> unsigned long p c i _ r e s o u r c e _ s t a r t ( s t r u c t pci_dev dev, i n t bar ) ; unsigned long p c i _ r e s o u r c e _ e n d ( s t r u c t pci_dev dev, i n t bar ) ; Gibt Anfang bzw. Ende des von Basis-Adress-Register bar bezeichneten Adressbereichs des Geräts dev zurück. pci_resource_len #i n c l u d e <l i n u x / p c i. h> unsigned long p c i _ r e s o u r c e _ l e n ( s t r u c t pci_dev dev, i n t bar ) ; Gibt die Länge des von Basis-Adress-Register bar bezeichneten Adressbereichs des Geräts dev zurück. Treiber PCI-Subsystem 20/

21 Ressourcen ermitteln (3) Direktzugriff #i n c l u d e <l i n u x / p c i. h> i n t p c i _ r e a d _ c o n f i g _ b y t e ( s t r u c t pci_dev dev, i n t where, u8 v a l ) ; i n t pci_read_config_word ( s t r u c t pci_dev dev, i n t where, u16 v a l ) ; i n t pci_read_config_dword ( s t r u c t pci_dev dev, i n t where, u32 v a l ) ; Liest ein Byte/Word/Dword aus dem Config-Space des Geräts dev bei Position where und schreibt es nach *val, Rückgabewert: Anzahl der gelesenen Bytes. Treiber PCI-Subsystem 21/

22 Ressourcen Beispiel Beispiel s t a t i c unsigned long i o p o r t =0, i o l e n =0;... / probe : / s t a t i c i n t d e v i n i t dhwk_probe ( s t r u c t pci_dev dev, const s t r u c t p c i _ d e v i c e _ i d i d ) { p c i _ e n a b l e _ d e v i c e ( dev ) ; i f ( p c i _ r e q u e s t _ r e g i o n s ( dev, "dhwk" ) ) { r e t u r n EIO ; } i o p o r t = p c i _ r e s o u r c e _ s t a r t ( dev, 0 ) ; i o l e n = p c i _ r e s o u r c e _ l e n ( dev, 0 ) ; r e t u r n 0 ; } Treiber PCI-Subsystem 22/

23 Ressourcen freigeben Bei seiner Deinitialisierung muss der Treiber angeforderte IO-Ressourcen wieder freigeben. pci_release_regions #i n c l u d e <l i n u x / p c i. h> void p c i _ r e l e a s e _ r e g i o n s ( s t r u c t pci_dev pdev ) ; Alle IO- und Speicher-Ressourcen des Geräts pdev werden freigegeben. Treiber PCI-Subsystem 23/

24 Ressourcen freigeben (2) release_region #i n c l u d e <l i n u x / i o p o r t. h> void r e l e a s e _ r e g i o n ( u n s g i n e d long from, u n s i g e n d long l e n g t h ) ; Der IO-Bereich der Länge length ab Adresse from wird freigegeben. release_mem_region #i n c l u d e <l i n u x / i o p o r t. h> void release_mem_region ( u n s g i n e d long from, u n s i g e n d long l e n g t h ) ; Der Speicher-IO-Bereich der Länge length ab Adresse from wird freigegeben. Treiber PCI-Subsystem 24/

25 Ressourcen freigeben Beispiel Beispiel / remove : / s t a t i c void devexit dhwk_remove ( s t r u c t pci_dev dev ) { p c i _ r e l e a s e _ r e g i o n s ( dev ) ; } Treiber PCI-Subsystem 25/

26 Hardwarezugriff Eigentlicher Datenaustausch mit der Hardware. Unterscheidung von zwei Arten: Port-IO Ein-/Ausgabe über Port-Adressen im gesonderten IO-Adressbereich, Memory-Mapped-IO Ein-/Ausgabe über in den Adressbereich des Arbeitsspeichers eingeblendete IO-Bereiche. Treiber PCI-Subsystem 26/

27 Hardwarezugriff Port-IO in #i n c l u d e <asm/ i o. h> u8 i n b ( i n t p o r t ) ; u16 inw ( i n t p o r t ) ; u32 i n l ( i n t p o r t ) ; Liest ein Byte/Word/Dword vom Port port ein und gibt es zurück. out #i n c l u d e <asm/ i o. h> void outb ( u8 v a l u e, i n t p o r t ) ; void outw ( u16 v a l u e, i n t p o r t ) ; void o u t l ( u32 v a l u e, i n t p o r t ) ; Schreibt das Byte/Word/Dword value auf den Port port. Treiber PCI-Subsystem 27/

28 Hardwarezugriff Port-IO (2) ins #i n c l u d e <asm/ i o. h> void i n s b ( i n t port, void addr, unsigned long count ) ; void insw ( i n t port, void addr, unsigned long count ) ; void i n s l ( i n t port, void addr, unsigned long count ) ; Liest vom Port port count Mal Bytes/Words/Dwords ein und schreibt sie ab Adresse addr in den Speicher. outs #i n c l u d e <asm/ i o. h> void outsb ( i n t port, void addr, unsigned long count ) ; void outsw ( i n t port, void addr, unsigned long count ) ; void o u t s l ( i n t port, void addr, unsigned long count ) ; Schreibt auf den Port port count Mal die ab Adresse addr stehenden Bytes/Words/Dwords. Treiber PCI-Subsystem 28/

29 Hardwarezugriff Port-IO (3) Verzögerte IO Die Makros inb_p, inw_p, inl_p, outb_p, outw_p, outl_p, machen dasselbe wie ihre Pendants ohne _p, allerdings mit einer kurzen Verzögerung nach der IO-Operation. Treiber PCI-Subsystem 29/

30 Hardwarezugriff Memory-Mapped-IO ioremap #i n c l u d e <asm/ i o. h> void ioremap ( r e s o u r c e _ s i z e _ t o f f s e t, unsigned long s i z e ) ; void ioremap_nocache ( r e s o u r c e _ s i z e _ t o f f s e t, unsigned long s i z e ) ; void ioremap_cache ( r e s o u r c e _ s i z e _ t o f f s e t, unsigned long s i z e ) ; Blendet den bei offset beginnenden IO-Speicher der Länge size ein, Speicherbereich wird als nicht-cachebar bzw. cachebar markiert, Rückgabewert: Startadresse des gemappten Speichers oder NULL bei Fehler. Treiber PCI-Subsystem 30/

31 Hardwarezugriff Memory-Mapped-IO (2) iounmap #i n c l u d e <asm/ i o. h> void iounmap ( void addr ) ; Blendet den bei addr gemappten Speicher wieder aus. Treiber PCI-Subsystem 31/

32 Hardwarezugriff Memory-Mapped-IO (3) read #i n c l u d e <asm/ i o. h> u8 readb ( void addr ) ; u16 readw ( void addr ) ; u32 r e a d l ( void addr ) ; Liest ein Byte/Word/Dword von Adresse addr ein und gibt es zurück. write #i n c l u d e <asm/ i o. h> void w r i t e b ( u8 v a l u e, void addr ) ; void writew ( u16 v a l u e, void addr ) ; void w r i t e l ( u32 v a l u e, void addr ) ; Schreibt das Byte/Word/Dword value nach Adresse addr. Treiber PCI-Subsystem 32/

33 Hardwarezugriff Memory-Mapped-IO (4) Kopieren von Blöcken #i n c l u d e <asm/ i o. h> void memset_io ( void d, i n t c, s i z e _ t n ) ; void memcpy_fromio ( void d, const void s, s i z e _ t n ) ; void memcpy_toio ( void d, const void s, s i z e _ t n ) ; memset_io initialisiert den bei d beginnenden IO-Bereich der Länge n mit dem Wert c, die beiden memcpy-varianten kopieren n Bytes von s nach d, wobei beim ersten die Quelle, bei zweiten das Ziel ein IO-Bereich ist, Rückgabewert: d. Treiber PCI-Subsystem 33/

34 Interrupts Mittels Interrupts signalisieren Hardware-Komponenten wichtige Ereignisse (z.b. Empfangspuffer voll ). Das Auftreten eines Interrupts führt i.d.r. dazu, dass der aktuelle Prozess unterbrochen, in den privilegierten Modus gewechselt und eine spezielle Behandlungsprozedur ausgeführt wird. Voraussetzungen Für die Interruptbehandlung muss: eine Interrupt-Handlerroutine implementiert werden, die Routine als Ressource beim IO-Subsystem für den richtigen Interrupt registriert werden. Treiber PCI-Subsystem 34/

35 Interrupts Interrupt-Service-Routine ISR i r q r e t u r n _ t d r i v e r _ i s r ( i n t i r q _ n r, void dev_id ) ; Muss vom Treiber implementiert werden, wird vom Kern aufgerufen, wenn der Interrupt irq_nr aufgetreten ist, dev_id ist die bei der Registrierung vergebene ID, Rückgabewert: IRQ_HANDLED, falls der Interrupt von der eigenen Hardware ausgelöst wurde, IRQ_NONE sonst. Treiber PCI-Subsystem 35/

36 API: request_irq request_irq #i n c l u d e <l i n u x / i n t e r r u p t. h> i n t r e q u e s t _ i r q ( unsigned i n t i r q, i r q r e t u r n _ t ( i s r ) ( i n t, void ), unsigned long f l a g s, const char devname, void dev_id ) ; Registriert den Interrupt-Handler isr unter dem Interrupt irq, devname bezeichnet den Namen des Geräts (erscheint bei Erfolg in /proc/interrupts), dev_id muss ein hinreichend eindeutiger Wert sein (z.b. ein Zeiger auf eine Verwaltungsstruktur des Treibers), flags: siehe nächste Folie, Rückgabewert: 0 bei Erfolg, negativer Fehlercode sonst. Treiber PCI-Subsystem 36/

37 API: request_irq (2) Flags Bezeichner IRQF_SHARED IRQF_DISABLED IRQF_SAMPLE_RANDOM Bedeutung IRQ darf von mehreren Treibern verwendet werden, (lokale) Interrupts sind während der Abarbeitung der ISR gesperrt, Interrupt darf als Entropiequelle genutzt werden. Treiber PCI-Subsystem 37/

38 API: free_irq free_irq #i n c l u d e <l i n u x / i n t e r r u p t. h> void f r e e _ i r q ( unsigned i n t i r q, void dev_id ) ; Gibt die unter dev_id registrierte, dem Interrupt irq zugeordnete Interrupt-Ressource frei. Treiber PCI-Subsystem 38/

39 Interrupts Beispiel Beispiel i r q r e t u r n _ t dhwk_isr ( i n t i r q, void dev_id ) { i f ( / u n s e r e hw war s / ) { / b e h a n d l e i r q und b e s e i t i g e i r q grund / r e t u r n IRQ_HANDLED ; } r e t u r n IRQ_NONE ; }... Treiber PCI-Subsystem 39/

40 Interrupts Beispiel (2) Beispiel (Forts.)... / probe : / s t a t i c i n t dhwk_probe ( s t r u c t pci_dev dev, const s t r u c t p c i _ d e v i c e _ i d i d ) { p c i _ e n a b l e _ d e v i c e ( dev ) ; i f ( r e q u e s t _ i r q ( dev >i r q, dhwk_isr, IRQF_DISABLED IRQF_SHARED, "dhwk", dev ) ) { r e t u r n EIO ; } r e t u r n 0 ; }... Treiber PCI-Subsystem 40/

41 Interrupts Beispiel (3) Beispiel (Forts.)... / remove : / s t a t i c void dhwk_remove ( s t r u c t pci_dev dev ) { f r e e _ i r q ( dev >i r q, dev ) ; } Treiber PCI-Subsystem 41/