Skip to content

M
Mock Turtle
Commit 3b77f039 authored by Federico Vaga's avatar Federico Vaga Committed by Federico Vaga
Browse files
Options

kernel: add shared messages 

Signed-off-by: 's avatarFederico Vaga <federico.vaga@gmail.com>
parent 45dadba8
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 324 additions and 85 deletions
doc/wrnc.tex
View file @ 3b77f039
......@@ -119,8 +119,7 @@ gatewares must be placed under \texttt{/lib/firmware} and loaded with
other fmc's drivers.
%FIXME it will change with UAL
\subsection{Software Installation}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Compilation}
\subsubsection{Compilation}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
There are not special requirements for the compilation, just run
\begin{verbatim}
......@@ -146,15 +145,7 @@ directories.
Note that the compilation process will also compile all the
applications under the directory \texttt{applications}.
\subsubsection{Library and Tools Installation}
Once you have compiled the library and tools you can install the
binaries in order to make them visible to the entire system.
\begin{verbatim}
make install
\end{verbatim}
\subsubsection{Driver Loading}
\subsection{Driver Loading}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
You can place the driver wherever you want and load it using
\texttt{modporbe(8)} or \texttt{insmod(8)}.
......@@ -164,11 +155,23 @@ The driver support the following module parameters:
driver internal queue for each slot.
\item[sync\_timeout] Maximum number of milli-seconds to wait for a
synchronous answer.
driver internal queue for each slot. Default is 32
\item[max\_slot\_con] Maximum number of consumers for a single slot.
Default is 8.
\item[slot\_share] Set default behaviour with multiple consumers.
Default is 0 (not shared)
\end{description}
\subsubsection{Library and Tools Installation}%%%%%%%%%%%%%%%%%%%%%%%
Once you have compiled the library and tools you can install the
binaries in order to make them visible to the entire system.
\begin{verbatim}
make install
\end{verbatim}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Software Usage}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Software Overview}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
In figure~\ref{fig:swgenstack} you can see an overview of the software
stack and the White-Rabbit Node-Core internal components seen by the
driver.
......@@ -198,8 +201,13 @@ communicate with the White-Rabbit Node-Core is through its Linux
driver; there are not other ways to access it.
\subsection{Library Interface}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
More details about the White-Rabbit Node-Core library API are
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{The Library}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The White-Rabbit Node-Core library allows you a complete access to
all the drivers capabilities.
All details about the White-Rabbit Node-Core library API are
available through the doxygen documentation. To build the doxygen
documentation, run the following commands:
......@@ -214,13 +222,24 @@ documentation. For each application you should find a \texttt{doc}
directory where you can build the doxygen documentation or any other
kind of documentation.
\subsection{Suggestions}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Following a list of suggestions that may helps you during the
development:
\subsection{Driver Interface}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{itemize}
\item use \texttt{wrnc\_strerror()} to prints errors from the
library.
\end{itemize}
\subsection{Installation}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{The Driver}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The driver is the only software component in the stack that can access
the White-Rabbit Node-Core component on the FPGA. The White-Rabbit
Node-Core exports two communication channels: Host-Message-Queue and
the Shared-Memory. These communication channels are used to communicate
between a real-time application, running on the
the Shared-Memory. These communication channels are used to
communicate between a real-time application, running on the
CPU\footnote{Internally, the White-Rabbit Node-Core has up to 8 CPUs.
Each CPU runs, independently, a real-time application.}, and the Linux
driver.
......@@ -236,8 +255,8 @@ according to the White-Rabbit Node-Core configuration.
\label{fig:swdrvhier}
\end{figure}
The Linux device driver export three interfaces: sysfs attributes,
char-devices and debugfs.
The Linux device driver export three interfaces: \textit{sysfs attributes},
\textit{char-devices} and \textit{debugfs}.
\subsubsection{Debugfs Interface}
The purpose of the \textit{debugfs} is to provide debuggin information.
......@@ -258,7 +277,7 @@ CPU we have a debugfs file. By reading the debugfs file you can
read the debug messages coming from the real-time application.
\end{description}
\subsubsection{Char-Devices Interface}
\subsection{Char-Devices Interface} %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
All char-devices are available under the directory \texttt{/dev/}.
\begin{description}
......@@ -281,7 +300,7 @@ supports \texttt{read}\footnote{on output slots},
\texttt{poll}
\end{description}
\subsubsection{Sysfs Interface}
\subsection{Sysfs Interface}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
You can find all the sysfs attributes under the directory
\texttt{/sys/class/wr-node-core/}. Following a table of all sysfs
attributes available.
......@@ -327,10 +346,14 @@ that it runs or pauses the code \\
\hline
hmq & full & RO & the hardware status of the HMQ slot is full \\
\hline
hmq & shared\_by\_users & RW & set if the HMQ slot char device
should share the same message with all users \\
\end{tabular}
\subsubsection{Load Real-Time Programs}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Driver Usage}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsubsection{Load Real-Time Programs}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Without applications the White-Rabbit Node-Core does nothing. So, to
make it productive we must load a real-time application on the CPU.
......@@ -461,7 +484,8 @@ order to mount \textit{debugfs}:
mount -t debugfs none /sys/kernel/debug/
\end{verbatim}
\subsection{Tools}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Tools}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Under the directory \texttt{tools} you can find the following
programs:
......@@ -482,11 +506,10 @@ Each tool has an internal help page accessible using the
command line option \texttt{-h}. Please use this help. We are not
providing information here in order to avoid inconsistencies.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{Bugs and Missing Features}%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{itemize}
\item Reading a slot is an exclusive operation. More threads cannot
read the same message from the same slot. (It will be implemented
later)
\item filtering debug messages is not possible yet
\item filtering messages is not possible yet
\end{itemize}
......
kernel/wrnc-core.c
View file @ 3b77f039
......@@ -467,6 +467,8 @@ static int wrnc_probe_hmq(struct wrnc_dev *wrnc, unsigned int slot,
hmq = is_input ? &wrnc->hmq_in[slot] : &wrnc->hmq_out[slot];
hmq->index = slot;
if (hmq_shared)
hmq->flags |= WRNC_FLAG_HMQ_SHR_USR;
err = wrnc_minor_get(&hmq->dev, WRNC_HMQ);
if (err)
......@@ -487,7 +489,9 @@ static int wrnc_probe_hmq(struct wrnc_dev *wrnc, unsigned int slot,
return err;
INIT_LIST_HEAD(&hmq->list_filters);
INIT_LIST_HEAD(&hmq->list_msg);
INIT_LIST_HEAD(&hmq->list_msg_input);
INIT_LIST_HEAD(&hmq->list_usr);
if (is_input) { /* CPU input */
hmq->flags |= WRNC_FLAG_HMQ_DIR;
hmq->base_sr = wrnc->base_hmq + MQUEUE_BASE_IN(slot);
......@@ -499,8 +503,6 @@ static int wrnc_probe_hmq(struct wrnc_dev *wrnc, unsigned int slot,
fmc_writel(fmc, MQUEUE_CMD_PURGE,
hmq->base_sr + MQUEUE_SLOT_COMMAND);
hmq->count = 0;
return 0;
}
......
kernel/wrnc-hmq.c
View file @ 3b77f039
This diff is collapsed.
kernel/wrnc-user.h
View file @ 3b77f039
......@@ -90,7 +90,7 @@ struct wrnc_smem_io {
/**
* Available ioctl() messages
*/
enum ual_ioctl_commands {
enum wrnc_ioctl_commands {
WRNC_MSG_SYNC, /**< send a synchronous message */
WRNC_SMEM_IO, /**< access to shared memory */
WRNC_MSG_FILTER_ADD, /**< add a message filter */
......
kernel/wrnc.h
View file @ 3b77f039
......@@ -28,11 +28,16 @@
#define WRNC_FLAG_HMQ_SHR (1 << 1) /**< 1 shared, means that more than
1 CPU is using it */
#define WRNC_FLAG_HMQ_SHR_USR (1 << 2) /**< Shared by users */
#define WRNC_FLAG_HMQ_SYNC (1 << 3) /**< Next message is sync answer */
struct wrnc_msg_filter_element {
struct wrnc_msg_filter filter;
struct list_head list;
};
/**
* Available type of devices
*/
......@@ -62,12 +67,28 @@ struct wrnc_hmq {
uint32_t status; /**< describe the status of the HMQ slot from the
cpu point of view */
uint32_t base_sr; /**< base address of the slot register */
struct list_head list_msg; /**< list of messages to/from th HMQ */
unsigned int count; /**< number of messages in the list */
struct list_head list_msg_input; /**< list of messages to
input slot */
unsigned int n_input; /**< number of messages in the list */
struct spinlock lock; /**< to protect list read/write */
struct mutex mtx; /**< to protect operations on the HMQ */
wait_queue_head_t q_msg; /**< wait queue for synchronous messages */
struct list_head list_usr; /**< list of consumer of the output slot */
unsigned int n_user; /**< number of users in the list */
};
/**
* It describes the consumer of the output slot
*/
struct wrnc_hmq_user {
struct list_head list; /**< to keep it in our local queue */
struct wrnc_hmq *hmq; /**< reference to opened HMQ */
struct spinlock lock; /**< to protect list read/write */
struct list_head list_msg_output; /**< list of messages from
output slot */
unsigned int n_output; /**< number of messages in the list */
struct list_head list_filters; /**< list of filters to apply */
unsigned int n_filters; /**< number of filters */
struct spinlock lock_filter; /**< to protect filter list read/write */
......@@ -127,6 +148,7 @@ extern void wrnc_cpu_enable_set(struct wrnc_dev *wrnc, uint8_t mask);
extern void wrnc_cpu_reset_set(struct wrnc_dev *wrnc, uint8_t mask);
extern irqreturn_t wrnc_irq_handler_debug(int irq_core_base, void *arg);
/* HMQ */
extern int hmq_shared;
extern int hmq_max_msg;
extern const struct attribute_group *wrnc_hmq_groups[];
extern const struct file_operations wrnc_hmq_fops;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment