[libvirt] [PATCH V1 3/6] Add documentation for TPM in domain XML

[Daniel P. Berrange]

On Wed, Mar 13, 2013 at 12:03:51PM -0400, Stefan Berger wrote:
> Signed-off-by: Stefan Berger <stefanb at linux.vnet.ibm.com>
> 
> ---
>  docs/formatdomain.html.in |   57 ++++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 57 insertions(+)

This ought to be part of the patch which introduces the RNG schema
and parser.

> 
> Index: libvirt/docs/formatdomain.html.in
> ===================================================================
> --- libvirt.orig/docs/formatdomain.html.in
> +++ libvirt/docs/formatdomain.html.in
> @@ -4336,6 +4336,63 @@ qemu-kvm -net nic,model=? /dev/null
>  
>      </dl>
>  
> +    <h4><a name="elementsTpm">TPM device</a></h4>
> +
> +    <p>
> +      The TPM device enables a QEMU guest to have access to TPM
> +      functionality.
> +    </p>
> +    <p>
> +      The TPM passthrough device type provides access to the host's TPM
> +      for one QEMU guest. No other software may be is using the TPM device,
> +      typically /dev/tpm0, at the time the QEMU guest is started.
> +      <span class="since">'passthrough' since 1.0.4</span>
> +    </p>
> +
> +    <p>
> +     Example: usage of the TPM passthrough device
> +    </p>
> +<pre>
> +  ...
> +  <device>
> +    <tpm model='tpm-tis'>
> +      <backend type='passthrough'>
> +        <backend path='/dev/tpm0'/>
> +      </backend>
> +    </tpm>
> +  </device>
> +</pre>
> +    <dl>
> +      <dt><code>model</code></dt>
> +      <dd>
> +        <p>
> +          The <code>model</code> attribute specifies what device
> +          model QEMU provides to the guest. If no model name is provided,
> +          <code>tpm-tis</code> will automatically be chosen.
> +        </p>
> +      </dd>
> +      <dt><code>backend</code></dt>
> +      <dd>
> +        <p>
> +          The <code>backend</code> element specifies the type of
> +          TPM device. The following types are supported:
> +        </p>
> +        <ul>
> +          <li>'passthrough' — use the hosts's TPM device.
> +        </ul>
> +      </dd>
> +      <dt><code>backend type='passthrough'</code></dt>
> +      <dd>
> +        <p>
> +          This backend type requires exclusive access to a TPM device on
> +          the host.
> +          An example for such a device is /dev/tpm0. The filename is
> +          specified as path attribute of the <code>source</code> element.
> +          If no file name is specified then /dev/tpm0 is automatically used.
> +        </p>
> +      </dd>
> +    </dl>
> +
>      <h3><a name="seclabel">Security label</a></h3>
>  
>      <p>
> 


Daniel
-- 
|: http://berrange.com      -o-    http://www.flickr.com/photos/dberrange/ :|
|: http://libvirt.org              -o-             http://virt-manager.org :|
|: http://autobuild.org       -o-         http://search.cpan.org/~danberr/ :|
|: http://entangle-photo.org       -o-       http://live.gnome.org/gtk-vnc :|