The Linux kernel labs documentation is a collection of "labs" for
various device driver topics. For each topic there are two parts: a
walk-through which explain the basic concepts and a hands-on part which
contains a few exercises.

This commit also adds the labs infrastructure which allows us to build
and test kernel modules in a qemu environment.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add the documentation and templates for the kernel modules lab which
focuses on: creating simple modules; describing the process of kernel
module compilation; presenting how a module can be used with a kernel;
simple kernel debugging methods

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add the documentation and templates for the kernel modules lab which
focuses on: familiarizing with the basic Linux kernel API, describing
memory allocation and locking mechanism.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the device drivers labs which
focuses on: understanding the concepts behind character device drivers;
understading the various operations that can be performed on character
device drivers; working with waiting queues.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the I/O access and interrupts lab
which focuses on: communication with pheripheral devices; implementing
interrupt handlers; synchronizing interrupts with process context.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the deffered work lab which focuses
on: understanding deffered work; implementation of common tasks that use
deferred work; understanding the peculiarities of synchronization for
deferred work.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the memory mapping lab which focuses
on: understanding the address space mapping mechanism; learn about the
most important structures related to memory mapping.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentationa and templates for the Linux device module lab which
focuses on understanding the main Linux abstraction that deals with
devices: devices, buses, drivers, subsystems and classes.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

The Linux kernel labs documentation is a collection of "labs" for
various device driver topics. For each topic there are two parts: a
walk-through which explain the basic concepts and a hands-on part which
contains a few exercises.

This commit also adds the labs infrastructure which allows us to build
and test kernel modules in a qemu environment.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add the documentation and templates for the kernel modules lab which
focuses on: creating simple modules; describing the process of kernel
module compilation; presenting how a module can be used with a kernel;
simple kernel debugging methods

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add the documentation and templates for the kernel modules lab which
focuses on: familiarizing with the basic Linux kernel API, describing
memory allocation and locking mechanism.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the device drivers labs which
focuses on: understanding the concepts behind character device drivers;
understading the various operations that can be performed on character
device drivers; working with waiting queues.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the I/O access and interrupts lab
which focuses on: communication with pheripheral devices; implementing
interrupt handlers; synchronizing interrupts with process context.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the deffered work lab which focuses
on: understanding deffered work; implementation of common tasks that use
deferred work; understanding the peculiarities of synchronization for
deferred work.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentation and templates for the memory mapping lab which focuses
on: understanding the address space mapping mechanism; learn about the
most important structures related to memory mapping.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Add documentationa and templates for the Linux device module lab which
focuses on understanding the main Linux abstraction that deals with
devices: devices, buses, drivers, subsystems and classes.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>
Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Kernel labs v4.15

Since we are going to add lectures change the top level directory name
from labs to teaching/labs.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Enable hieroglyph extension if it is installed on the host and add a
slides documentation target.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

This is based on the psphinxcontrib.ditaa pip package and we add it
localy since we need some fixes to properly render images in
hieroglpyh slides.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Add reqirements.txt and run pip in the doc target to make sure we have
all required sphinx dependencies.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

This is split into two parts: one the is specific to cs.pub.ro and
another one that is generic.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Lklabs lectures intro

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Add docs building and publishing support via Circle CI

The conf.py needs to be at the top of the namespace directory so move
it where it belongs.

And since we now have multiple subdirectories and includes are
relative to current file directory, the common substitution will not
longer work for all files. To fix this, just move the contents of
subst.hrst directly to rst_epilog in conf.py.

Fixes the following errors:

deferred_work.rst:721: ERROR: Undefined substitution referenced: "LXR".
deferred_work.rst:721: ERROR: Unknown target name: "lxr".
interrupts.rst:688: ERROR: Undefined substitution referenced: "LXR".
interrupts.rst:688: ERROR: Unknown target name: "lxr".
kernel_api.rst:739: ERROR: Unexpected indentation.
kernel_api.rst:582: ERROR: Undefined substitution referenced: "LXR".
kernel_api.rst:582: ERROR: Unknown target name: "lxr".
kernel_modules.rst:810: ERROR: Undefined substitution referenced: "LXR".
kernel_modules.rst:939: ERROR: Undefined substitution referenced: "LXR".
kernel_modules.rst:810: ERROR: Unknown target name: "lxr".
kernel_modules.rst:939: ERROR: Unknown target name: "lxr".

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Documentation: move teaching/labs/conf.py to teaching/

Introduction lab presents few ways to navigate the kernel source code
(LXR and cscope) and how to perform static and dynamic kernel analysis
using gdb, vmlinux and /proc/kcore.

labs: add introduction lab

This makes it easier to edit ditaa directives since insertion will
always move the rest of the row by one.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Fixes the following warning:

Documentation/teaching/lectures/intro.rst:737: WARNING: Bullet list
ends without a blank line; unexpected unindent

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

As noted in Sphinx #2442 new CSS added by extensions are rendered
innefective if html_context its changed. So, instead, use add_stylesheet
to add theme_overridesc.css

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Add asciicast directive that allows inserting asciinema "asciicasts" in
docs. The directive accepts a single mandatory parameter which is the
filename that stores the asciicast:

.. asciicast:: ascii.cast

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Don't catch ditaa errors, let the user see them so that it is easier to
understand the root cause of failures.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Corrected minor typos in intro lecture

Add system calls lecture

Fix the "System Call Flow Summary" slide to fit by rephrasing some
bullets which should also hopefully make some points more clear.

Signed-off-by: Octavian Purdila <tavi@cs.pub.ro>

Documentation: teaching: syscall lecture: fix slide to fit

Signed-off-by: Robert Baronescu <baronescu.robert@gmail.com>

Documentation: teaching: lectures: intro.rst: Corrected minor typos

Add hello assignment in skels

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>

Add kernel API assignment

Signed-off-by: Anda Nicolae <nicolae.anda@gmail.com>

Lecture typo fixes and cscope optimization

Lab 2: Add missing dyndbg exercise.

lab 02 nitpicking and broken links fix

Signed-off-by: Robert Baronescu <baronescu.robert@gmail.com>

Documentation: teaching: lectures: syscalls.rst: Corrected minor typos

* update links to point to 4.15.7 kernel API
* use c constructs (:c:type:``, :c:macro:`` etc)
  to highlight structures, macros etc

Signed-off-by: Anda Nicolae <nicolae.anda@gmail.com>

teaching: labs: introduction: Fix typos

* removed links to lxr kernel API
* used :c:type:``, :c:data:``, :c:func:``, etc
  in all lab, when appropriate
* reformulated documentation when needed
* added missing list evolution image

Signed-off-by: Anda Nicolae <nicolae.anda@gmail.com>

lab03: kernel_api: update exercises requirements

Signed-off-by: Daniel Baluta <daniel.baluta@gmail.com>

Documentation: lectures: Add draft 'Interrupts' lecture

lab04: exercises: Fix TODO numbers.

Add tracer assignment