Added functions to move memory to and from user space.

[cascardo/kernel/old_slides/.git] / 01.hello / 01.hello.xml

diff --git a/01.hello/01.hello.xml b/01.hello/01.hello.xml
index 19aad0f..9eb0458 100644 (file)
--- a/01.hello/01.hello.xml
+++ b/01.hello/01.hello.xml
@@ -11,10 +11,73 @@
 <foil>
 <title>Introduction</title>
 <para>
+Let's take a look at how linux modules work.
+</para>
+</foil>
+
+<foil>
+<title>Building Linux</title>
+<para>
+But, first, we will build Linux. The procedure is configuring, building and
+installing. Try <screen>make help</screen>.
+</para>
+</foil>
+
+<foil>
+<title>Requirements</title>
+<para>
+We need the tools to build a module and a building linux tree. Running the built
+linux kernel is highly recommended so we can test our modules.
+</para>
+<para>
+The tools include GNU make, GCC and GNU binutils. Linux build is highly
+dependent on the GNU toolchain, since the beginning.
+</para>
+</foil>
+
+<foil>
+<title>Hands-on</title>
+<para>
 We have prepared sample code to build in the samples/ directory. Try them.
 </para>
 </foil>
 
+<foil>
+<title>Init and Exit Functions</title>
+<para>
+We use <emphasis>module\_init</emphasis> and <emphasis>module\_exit</emphasis>
+to declare our init and exit functions.
+</para>
+</foil>
+
+<foil>
+<title>Init and Exit Functions</title>
+<para>
+The <emphasis>\_\_init</emphasis> and <emphasis>\_\_exit</emphasis> marks allow
+the kernel to remove them when they are not needed, reducing memory consumption.
+</para>
+</foil>
+
+<foil>
+<title>printk</title>
+<para>
+<emphasis>printk</emphasis> is very similar to printf. The messages are usually
+preceded by a string in the form &lt;n&gt;, where <emphasis>n</emphasis> is a
+priority. There are macros, like <emphasis>KERN\_ALERT</emphasis> and
+<emphasis>KERN\_DEBUG</emphasis> to use for that.
+</para>
+</foil>
+
+<foil>
+<title>License and taint</title>
+<para>
+<emphasis>MODULE\_LICENSE</emphasis> is highly recommended. A free software
+license should be used, otherwise the kernel is tainted. This indicates to
+developers that something has gone wrong, and some bug reports are ignored some
+times.
+</para>
+</foil>
+
 <foil>
 <title>Building</title>
 <para>
@@ -25,4 +88,57 @@ $ make -C /lib/modules/`uname -r`/build M=$PWD modules
 </screen>
 </foil>
 
+<foil>
+<title>Module Tools</title>
+<itemizedlist>
+<listitem>
+insmod
+</listitem>
+<listitem>
+rmmod
+</listitem>
+<listitem>
+modprobe
+</listitem>
+<listitem>
+modinfo
+</listitem>
+<listitem>
+depmod
+</listitem>
+</itemizedlist>
+</foil>
+
+<foil>
+<title>Module Description Definitions</title>
+<itemizedlist>
+<listitem>
+MODULE\_AUTHOR
+</listitem>
+<listitem>
+MODULE\_DESCRIPTION
+</listitem>
+<listitem>
+MODULE\_VERSION
+</listitem>
+<listitem>
+MODULE\_LICENSE
+</listitem>
+<listitem>
+MODULE\_ALIAS
+</listitem>
+</itemizedlist>
+</foil>
+
+<foil>
+<title>Module parameters</title>
+<para>
+Besides <emphasis>MODULE\_PARM\_DESC</emphasis> to inform user about the
+parameter, we must use <emphasis>module\_param</emphasis>.
+</para>
+<screen>
+module_param(name, type, perm);
+</screen>
+</foil>
+
 </slides>