[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]
Subject: Re: [PATCH] latexify document more.
On Mon, Dec 02, 2013 at 04:56:16PM +1030, Rusty Russell wrote: > @@ -503,28 +512,30 @@ how to communicate with the specific device. > > The driver MUST follow this sequence to initialize a device: > > -1. Reset the device. > +\begin{enumerate} > +\item Reset the device. > > -2. Set the ACKNOWLEDGE status bit: we have noticed the device. > +\item Set the ACKNOWLEDGE status bit: we have noticed the device. > > -3. Set the DRIVER status bit: we know how to drive the device. > +\item Set the DRIVER status bit: we know how to drive the device. > > -4. Read device feature bits, and write the subset of feature bits > +\item Read device feature bits, and write the subset of feature bits > understood by the OS and driver to the device. > > -5. Set the FEATURES_OK status bit. The driver MUST not accept > +\item Set the FEATURES_OK status bit. The driver MUST not accept > new feature bits after this step. > > -6. Re-read the status byte to ensure the FEATURES_OK bit is still > +\item Re-read the status byte to ensure the FEATURES_OK bit is still > set: otherwise, the device does not support our subset of features > and the device is unusable. > > -7. Perform device-specific setup, including discovery of virtqueues for the > +\item Perform device-specific setup, including discovery of virtqueues for the > device, optional per-bus setup, reading and possibly writing the > device's virtio configuration space, and population of virtqueues. > > -8. Set the DRIVER_OK status bit. At this point the device is > +\item Set the DRIVER_OK status bit. At this point the device is > "live". > +\end{enumerate} > > If any of these steps go irrecoverably wrong, the driver SHOULD > set the FAILED status bit to indicate that it has given up on the Below this we have The result was the steps 5 and 6 were omitted, and steps 7 and 8 were conflated. thould be changed to cross-references. > @@ -568,27 +579,29 @@ they are used. > > The driver offers buffers to one of the device's virtqueues as follows: > > -1. The driver places the buffer into free descriptor(s) in the > +\begin{enumerate} > +\item The driver places the buffer into free descriptor(s) in the > descriptor table, chaining as necessary (see \ref{sec:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Descriptor Table}~\nameref{sec:Basic Facilities of a Virtio Device / Virtqueues / The Virtqueue Descriptor Table}). > > -2. The driver places the index of the head of the descriptor chain > +\item The driver places the index of the head of the descriptor chain > into the next ring entry of the available ring. > > -3. Steps (1) and (2) may be performed repeatedly if batching > +\item Steps (1) and (2) may be performed repeatedly if batching > is possible. These should be cross-references.
[Date Prev] | [Thread Prev] | [Thread Next] | [Date Next] -- [Date Index] | [Thread Index] | [List Home]