[FE training-materials-updates] Minor or cosmetic improvements
Michael Opdenacker
michael.opdenacker at free-electrons.com
Wed Oct 10 06:43:37 CEST 2012
Repository : git://git.free-electrons.com/training-materials.git
On branch : master
Link : http://git.free-electrons.com/training-materials/commit/?id=a9b08679a0731da7912d42dea566e1c528c2a63e
>---------------------------------------------------------------
commit a9b08679a0731da7912d42dea566e1c528c2a63e
Author: Michael Opdenacker <michael.opdenacker at free-electrons.com>
Date: Wed Oct 10 06:43:32 2012 +0200
Minor or cosmetic improvements
>---------------------------------------------------------------
a9b08679a0731da7912d42dea566e1c528c2a63e
...kernel-driver-development-character-drivers.tex | 6 +++---
.../kernel-driver-development-debugging.tex | 19 +++++++++----------
.../kernel-driver-development-dma.tex | 2 +-
.../kernel-driver-development-interrupts.tex | 2 +-
.../kernel-driver-development-io-memory.tex | 4 ++--
.../kernel-driver-development-mmap.tex | 2 +-
slides/sysdev-realtime/sysdev-realtime.tex | 4 ++--
.../sysdev-root-filesystem-device-files.tex | 4 ++--
8 files changed, 21 insertions(+), 22 deletions(-)
diff --git a/slides/kernel-driver-development-character-drivers/kernel-driver-development-character-drivers.tex b/slides/kernel-driver-development-character-drivers/kernel-driver-development-character-drivers.tex
index 3a72760..167bb86 100644
--- a/slides/kernel-driver-development-character-drivers/kernel-driver-development-character-drivers.tex
+++ b/slides/kernel-driver-development-character-drivers/kernel-driver-development-character-drivers.tex
@@ -374,7 +374,7 @@ static struct file_operations acme_fops =
};
\end{minted}
\item You just need to supply the functions you implemented!
- Defaults for other functions (such as open, release...) are fine
+ Defaults for other functions (such as \code{open}, \code{release}...) are fine
if you do not implement anything special.
\end{itemize}
\end{frame}
@@ -386,7 +386,7 @@ static struct file_operations acme_fops =
\begin{itemize}
\item Also called a \emph{device number}.
\item Defined in \code{linux/kdev_t.h}
- \item Linux 2.6: 32 bit size (major: 12 bits, minor: 20 bits)
+ \item 32 bit size (major: 12 bits, minor: 20 bits)
\item Macro to compose the device number
\begin{itemize}
\item \code{MKDEV(int major, int minor);}
@@ -521,7 +521,7 @@ unregister_chrdev_region(acme_dev, acme_count);
\begin{itemize}
\item The kernel convention for error management is
\begin{itemize}
- \item Return 0 on success
+ \item Return \code{0} on success
\item Return a negative error code on failure
\end{itemize}
\item Error codes
diff --git a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
index 474bea7..6043345 100644
--- a/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
+++ b/slides/kernel-driver-development-debugging/kernel-driver-development-debugging.tex
@@ -56,8 +56,8 @@
\begin{frame}
\frametitle{Configuring The Priority}
\begin{itemize}
- \item Each message is associated to a priority, ranging from 0 for
- emergency to 7 for debug.
+ \item Each message is associated to a priority, ranging from \code{0} for
+ emergency to \code{7} for debug.
\item All the messages, regardless of their priority, are stored in
the kernel log ring buffer
\begin{itemize}
@@ -114,19 +114,19 @@
\item \code{x} for hexadecimal representation
\end{itemize}
\end{itemize}
- \item Expose an integer as a file in debugfs:
+ \item Expose an integer as a file in DebugFS:
\begin{itemize}
\item \mint{c}+struct dentry *debugfs_create_{u,x}{8,16,32}+
\mint{c}+(const char *name, mode_t mode, struct dentry *parent,+
\mint{c}+u8 *value);+
\end{itemize}
- \item Expose a binary blob as a file in debugfs:
+ \item Expose a binary blob as a file in DebugFS:
\begin{itemize}
\item \mint{c}+struct dentry *debugfs_create_blob(const char *name,+
\mint{c}+mode_t mode, struct dentry *parent,+
\mint{c}+struct debugfs_blob_wrapper *blob);+
\end{itemize}
- \item Also possible to support writable debugfs file or customize
+ \item Also possible to support writable DebugFS files or customize
the output using the more generic \code{debugfs_create_file()}
function.
\end{itemize}
@@ -139,10 +139,10 @@
considered deprecated
\begin{itemize}
\item Adding special \code{ioctl()} commands for debugging
- purposes. debugfs is preferred.
- \item Adding special entries in the proc filesystem. debugfs is
+ purposes. DebugFS is preferred.
+ \item Adding special entries in the \code{proc} filesystem. DebugFS is
preferred.
- \item Adding special entries in the sysfs filesystem. debugfs is
+ \item Adding special entries in the \code{sysfs} filesystem. DebugFS is
preferred.
\item Using \code{printk()}. The \code{pr_*()} and \code{dev_*()}
functions are preferred.
@@ -179,8 +179,7 @@
from another machine, connected through a serial line.
\item Can do almost everything, including inserting breakpoints in
interrupt handlers.
- \item Feature included in standard Linux since 2.6.26 (x86 and
- sparc). arm, mips and ppc support merged in 2.6.27.
+ \item Feature supported for the most popular CPU architectures
\end{itemize}
\end{frame}
diff --git a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
index 18f8fe8..e8a8bc7 100644
--- a/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
+++ b/slides/kernel-driver-development-dma/kernel-driver-development-dma.tex
@@ -37,7 +37,7 @@
or \code{__get_free_pages} (up to 8MB).
\item Can use block I/O and networking buffers, designed to support
DMA.
- \item Can not use vmalloc memory (would have to setup DMA on each
+ \item Can not use \code{vmalloc} memory (would have to setup DMA on each
individual physical page).
\end{itemize}
\end{frame}
diff --git a/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex b/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
index 903be9e..02af926 100644
--- a/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
+++ b/slides/kernel-driver-development-interrupts/kernel-driver-development-interrupts.tex
@@ -85,7 +85,7 @@ Err: 0
\item \mint{c}+irqreturn_t foo_interrupt(int irq, void *dev_id)+
\begin{itemize}
\item \code{irq}, the IRQ number
- \item \code{dev_id}, the opaque pointer passed at
+ \item \code{dev_id}, the opaque pointer that was passed to
\code{request_irq()}
\end{itemize}
\item Return value
diff --git a/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex b/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
index 6583ac9..bda70c6 100644
--- a/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
+++ b/slides/kernel-driver-development-io-memory/kernel-driver-development-io-memory.tex
@@ -41,7 +41,7 @@ struct resource *request_region(
char *name);
\end{minted}
\item Tries to reserve the given region and returns \code{NULL} if unsuccessful.
- \item \code{request_region(0x0170, 8, "ide1");}
+ \item \mint{c}+request_region(0x0170, 8, "ide1");+
\item
\begin{minted}{c}
void release_region(
@@ -165,7 +165,7 @@ void *ioremap(unsigned long phys_addr,
unsigned long size);
void iounmap(void *address);
\end{minted}
- \item Caution: check that ioremap doesn't return a \code{NULL} address!
+ \item Caution: check that \code{ioremap} doesn't return a \code{NULL} address!
\end{itemize}
\end{frame}
diff --git a/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex b/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
index bf45341..af0b390 100644
--- a/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
+++ b/slides/kernel-driver-development-mmap/kernel-driver-development-mmap.tex
@@ -87,7 +87,7 @@ int (*mmap) (
\begin{frame}[fragile]
\frametitle{remap\_pfn\_range()}
\begin{itemize}
- \item pfn: page frame number
+ \item \emph{pfn}: page frame number
\item The most significant bits of the page address (without the
bits corresponding to the page size).
\end{itemize}
diff --git a/slides/sysdev-realtime/sysdev-realtime.tex b/slides/sysdev-realtime/sysdev-realtime.tex
index a043506..bac3307 100644
--- a/slides/sysdev-realtime/sysdev-realtime.tex
+++ b/slides/sysdev-realtime/sysdev-realtime.tex
@@ -1056,8 +1056,8 @@ echo 0 > /debug/tracing/tracing_enabled
essential for the implementation of the Xenomai real-time
extension:
\begin{itemize}
- \item Disables on-demand mapping of kernel-space vmalloc/ioremap
- areas.
+ \item Disables on-demand mapping of kernel-space \code{vmalloc} /
+ \code{ioremap} areas.
\item Disables copy-on-write when real-time processes are forking.
\item Allow subscribing to event allowing to follow progress of
the Linux kernel, such as Linux system calls, context switches,
diff --git a/slides/sysdev-root-filesystem-device-files/sysdev-root-filesystem-device-files.tex b/slides/sysdev-root-filesystem-device-files/sysdev-root-filesystem-device-files.tex
index a32a120..4e7560a 100644
--- a/slides/sysdev-root-filesystem-device-files/sysdev-root-filesystem-device-files.tex
+++ b/slides/sysdev-root-filesystem-device-files/sysdev-root-filesystem-device-files.tex
@@ -79,12 +79,12 @@ crw-rw-rw- 1 root root 1, 5 2011-05-27 08:56 /dev/zero
Example C code that uses the usual file API to write data to a serial port
\small
-\begin{verbatim}
+\begin{minted}{c}
int fd;
fd = open("/dev/ttyS0", O_RDWR);
write(fd, "Hello", 5);
close(fd);
-\end{verbatim}
+\end{minted}
\end{frame}
\begin{frame}
More information about the training-materials-updates
mailing list