forked from oasis-tcs/virtio-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
newdevice: Improve the appendix chapter heading to reflect the content
Current appendix chapter already covers useful notes for creating new device types and also for extending the device in 'device improvements' section. The chapter heading was not reflecting the notation for extending the existing device. This sometimes creates confusion/misinterpretation to readers. Hence fix the heading to reflect the written sections. While at it, remove the empty lines at the end of the file. Fixes: oasis-tcs#179 Signed-off-by: Parav Pandit <[email protected]> Acked-by: Satananda Burla <[email protected]>
- Loading branch information
1 parent
083e7c7
commit 51dab19
Showing
1 changed file
with
7 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,9 +1,9 @@ | ||
\chapter{Creating New Device Types}\label{sec:Creating New Device Types} | ||
\chapter{Creating New Device Types or Extending the Device}\label{sec:Creating New Device Types or Extending the Device} | ||
|
||
Various considerations are necessary when creating a new device | ||
type. | ||
type or when extending the device functionality. | ||
|
||
\section{How Many Virtqueues?}\label{sec:Creating New Device Types / How Many Virtqueues?} | ||
\section{How Many Virtqueues?}\label{sec:Creating New Device Types or Extending the Device / How Many Virtqueues?} | ||
|
||
It is possible that a very simple device will operate entirely | ||
through its device configuration space, but most will need at least one | ||
|
@@ -13,7 +13,7 @@ \section{How Many Virtqueues?}\label{sec:Creating New Device Types / How Many Vi | |
receive input, and one which the driver places buffers to | ||
transmit output. | ||
|
||
\section{What Device Configuration Space Layout?}\label{sec:Creating New Device Types / What Device Configuration Space Layout?} | ||
\section{What Device Configuration Space Layout?}\label{sec:Creating New Device Types or Extending the Device / What Device Configuration Space Layout?} | ||
|
||
Device configuration space should only be used for initialization-time | ||
parameters. It is a limited resource with no synchronization between | ||
|
@@ -26,15 +26,15 @@ \section{What Device Configuration Space Layout?}\label{sec:Creating New Device | |
writable by the driver. Therefore, no writeable field which triggers an | ||
action ought to be wider than 32 bits. | ||
|
||
\section{What Device Number?}\label{sec:Creating New Device Types / What Device Number?} | ||
\section{What Device Number?}\label{sec:Creating New Device Types or Extending the Device / What Device Number?} | ||
|
||
Device numbers can be reserved by the OASIS committee: email | ||
[email protected] (after subscribing through | ||
[email protected]) to secure a unique one. | ||
|
||
Meanwhile for experimental drivers, use 65535 and work backwards. | ||
|
||
\section{How many MSI-X vectors? (for PCI)}\label{sec:Creating New Device Types / How many MSI-X vectors? (for PCI)} | ||
\section{How many MSI-X vectors? (for PCI)}\label{sec:Creating New Device Types or Extending the Device / How many MSI-X vectors? (for PCI)} | ||
|
||
Using the optional MSI-X capability devices can speed up | ||
interrupt processing by removing the need to read ISR Status | ||
|
@@ -52,7 +52,7 @@ \section{How many MSI-X vectors? (for PCI)}\label{sec:Creating New Device Types | |
number of vectors as possible, or disabling MSI-X capability | ||
altogether. | ||
|
||
\section{Device Improvements}\label{sec:Creating New Device Types / Device Improvements} | ||
\section{Device Improvements}\label{sec:Creating New Device Types or Extending the Device / Device Improvements} | ||
|
||
Any change to device configuration space, or new virtqueues, or | ||
behavioural changes, should be indicated by negotiation of a new | ||
|
@@ -64,5 +64,3 @@ \section{Device Improvements}\label{sec:Creating New Device Types / Device Impro | |
can use a single bit, but if one feature makes sense without the | ||
others they should not be gratuitously grouped together to | ||
conserve feature bits. | ||
|
||
|