The Linux Loadable Kernel Module How-To

Bryan Henderson

2006-09-24

This is the HOWTO for Linux loadable kernel modules (LKMs). It explains what they are and how to use and create them. It also includes documentation of parameters and other details of use of some particular modules.

• Table of Contents
• 1. Preface
• 2. Introduction to Linux Loadable Kernel Modules
   
• 2.1. Terminology
• 2.2. History of Loadable Kernel Modules
• 2.3. The Case For Loadable Kernel Modules
• 2.4. What LKMs Can't Do
• 2.5. What LKMs Are Used For


• 3. Making Loadable Kernel Modules
• 4. LKM Utilities
• 5. How To Insert And Remove LKMs
   
• 5.1. Could Not Find Kernel Version...
• 5.2. What Happens When An LKM Loads
• 5.3. Intelligent Loading Of LKMs - Modprobe
• 5.4. Automatic LKM Loading and Unloading
• 5.5. /proc/modules
• 5.6. Where Are My LKM Files On My System?


• 6. Unresolved Symbols
   
• 6.1. Some LKMs Prerequire Other LKMs
• 6.2. An LKM Must Match The Base Kernel
• 6.3. If You Run Multiple Kernels
• 6.4. SMP symbols
• 6.5. You Are Not Licensed To Access The Symbol
• 6.6. An LKM Must Match Prerequisite LKMs


• 7. How To Boot Without A Disk Device Driver
• 8. About Module Parameters
• 9. Persistent Data
• 10. Technical Details
   
• 10.1. How They Work
• 10.2. The .modinfo Section
• 10.3. The __ksymtab And .kstrtab Sections
• 10.4. Ksymoops Symbols
• 10.5. Other Symbols
• 10.6. Debugging Symbols
• 10.7. Memory Allocation For Loading
• 10.8. Linux internals


• 11. Writing Your Own Loadable Kernel Module
   
• 11.1. Simpler hello.c
• 11.2. Using the Kernel Build System
• 11.3. Rubini et al: Linux Device Drivers
• 11.4. Module Use Counts


• 12. Differences Between Versions Of Linux
   
• 12.1. Linux 2.4 - Linux 2.6


• 13. Copyright Considerations With LKMs
• 14. Related Documentation
• 15. Individual Modules
   
• 15.1. Executable Interpreters
• 15.2. Block Device Drivers
• 15.3. SCSI Drivers
• 15.4. Network Device Drivers
• 15.5. CDROM Device Drivers
• 15.6. Filesystem Drivers
• 15.7. Miscellaneous Device Driver
• 15.8. Serial Device Drivers
• 15.9. Parallel Device Drivers
• 15.10. Bus Mouse Device Drivers
• 15.11. Tape Device Drivers
• 15.12. Watchdog Timers
• 15.13. Sound Device Drivers


• 16. Maintenance Of This Document
• 17. History
• 18. Copyright

             Next
             Preface

* License

* Loadable Kernel Module How-To Index