All of lore.kernel.org
 help / color / mirror / Atom feed
From: Halil Pasic <pasic@linux.ibm.com>
To: virtio@lists.oasis-open.org, virtio-dev@lists.oasis-open.org
Cc: "Michael S. Tsirkin" <mst@redhat.com>,
	Cornelia Huck <cohuck@redhat.com>,
	Pawel Moll <pawel.moll@arm.com>,
	Halil Pasic <pasic@linux.ibm.com>
Subject: [virtio] [PATCH 2/6] notifications: notifications as basic virtio facility
Date: Thu, 26 Apr 2018 12:59:58 +0200	[thread overview]
Message-ID: <1524740402-18934-3-git-send-email-pasic@linux.ibm.com> (raw)
In-Reply-To: <1524740402-18934-1-git-send-email-pasic@linux.ibm.com>

Let's introduce notifications as basic virtio facility early on. This
shall not only increase the cohesion between core and transport
description by having a well-defined  place where notifications are
introduced, but also give us the opportunity to explain some
discrepancies.

Namely notifications sent by the device to the driver were often called
interrupts prior to v1.1. Getting completely rid of that terminology is
however not viable in case of some names.

Signed-off-by: Halil Pasic <pasic@linux.ibm.com>
---
Changelog:
RFC -> v1:
* implemented Connies suggestions (thanks Connie)
---
 content.tex |   36 ++++++++++++++++++++++++++++++++++++
 1 files changed, 36 insertions(+), 0 deletions(-)

diff --git a/content.tex b/content.tex
index 2e103cf..d7e2b18 100644
--- a/content.tex
+++ b/content.tex
@@ -8,6 +8,7 @@ device consists of the following parts:
 \begin{itemize}
 \item Device status field
 \item Feature bits
+\item Notifications
 \item Device Configuration space
 \item One or more virtqueues
 \end{itemize}
@@ -150,6 +151,41 @@ requirements documented within these legacy interface sections.
 Specification text within these sections generally does not apply
 to non-transitional devices.
 
+\section{Notifications}\label{sec:Basic Facilities of a Virtio Device
+/ Notifications}
+
+The notion of sending a notification (driver to device or device
+to driver) plays an important role in this specification. The
+modus operandi of the notifications is transport specific.
+
+There are three types of notifications: 
+\begin{itemize}
+\item device configuration space notification
+\item available buffers notification
+\item used buffer notifications. 
+\end{itemize}
+
+Device configuration space notifications and used buffer notifications
+are sent by the device, the recipient is the driver. A device
+configuration space notification indicates that a configuration space
+has changed; a used buffer notification indicates that a buffer may
+have been made used on the virtqueue designated by the notification.
+
+Available buffer notifications are sent by the driver, the recipient is
+the device. This type of notification indicates that a buffer may have
+been made available on the virtqueue designated by the notification.
+
+The semantic, the transport-specific implementations and other
+important aspects of the different notifications are specified in detail
+in the following chapters
+
+Most transports implement notifications sent by the device to the
+driver using interrupts. Therefore, in previous versions of this
+specification, these notifications were often called interrupts.
+Some names defined in this specification still retain this interrupt
+terminology. Occasionally, the term event is used to refer to
+a notification or a receipt of a notification.
+
 \section{Device Configuration Space}\label{sec:Basic Facilities of a Virtio Device / Device Configuration Space}
 
 Device configuration space is generally used for rarely-changing or
-- 
1.7.1


---------------------------------------------------------------------
To unsubscribe from this mail list, you must leave the OASIS TC that 
generates this mail.  Follow this link to all your TCs in OASIS at:
https://www.oasis-open.org/apps/org/workgroup/portal/my_workgroups.php 


  parent reply	other threads:[~2018-04-26 10:59 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-04-26 10:59 [virtio] [PATCH 0/6] rework notifications terminology Halil Pasic
2018-04-26 10:59 ` [virtio] [PATCH 1/6] notifications: unify notifications wording in core Halil Pasic
2018-05-14 16:36   ` [virtio] Re: [virtio-dev] " Stefan Hajnoczi
2018-05-14 19:40     ` Halil Pasic
2018-05-15  9:09       ` Stefan Hajnoczi
2018-04-26 10:59 ` Halil Pasic [this message]
2018-05-14 17:24   ` [virtio] Re: [virtio-dev] [PATCH 2/6] notifications: notifications as basic virtio facility Stefan Hajnoczi
2018-05-15  9:09     ` Halil Pasic
2018-04-26 10:59 ` [virtio] [PATCH 3/6] ccw: map common notifications terminology to ccw Halil Pasic
2018-05-14 17:27   ` [virtio] Re: [virtio-dev] " Stefan Hajnoczi
2018-04-26 11:00 ` [virtio] [PATCH 4/6] pci: map common notifications terminology to PCI Halil Pasic
2018-05-15  8:51   ` Stefan Hajnoczi
2018-04-26 11:00 ` [virtio] [PATCH 5/6] mmio: map common notifications terminology to MMIO Halil Pasic
2018-05-15  8:58   ` Stefan Hajnoczi
2018-05-15  9:25     ` [virtio] Re: [virtio-dev] " Halil Pasic
2018-04-26 11:00 ` [virtio] [PATCH 6/6] notifications: update notifications terminology for devices Halil Pasic
2018-05-15  9:00   ` Stefan Hajnoczi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1524740402-18934-3-git-send-email-pasic@linux.ibm.com \
    --to=pasic@linux.ibm.com \
    --cc=cohuck@redhat.com \
    --cc=mst@redhat.com \
    --cc=pawel.moll@arm.com \
    --cc=virtio-dev@lists.oasis-open.org \
    --cc=virtio@lists.oasis-open.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.