From a2b299179dca87c66e11238b53500b6e8c55729e Mon Sep 17 00:00:00 2001
From: Conghui Chen <conghui.chen@intel.com>
Date: Thu, 9 Aug 2018 05:25:56 +0000
Subject: [PATCH] doc: update virtio-blk usage in HLD

Add parameters introduction for virtio-blk

Signed-off-by: Conghui Chen <conghui.chen@intel.com>
Reviewed-by: Shuo Liu <shuo.a.liu@intel.com>
Reviewed-by: David B. Kinder <david.b.kinder@intel.com>
---
 doc/developer-guides/virtio-hld.rst | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/doc/developer-guides/virtio-hld.rst b/doc/developer-guides/virtio-hld.rst
index 5899b1c8f..6d7b846b6 100644
--- a/doc/developer-guides/virtio-hld.rst
+++ b/doc/developer-guides/virtio-hld.rst
@@ -530,7 +530,25 @@ VTBLK_F_TOPOLOGY(bit 10)
 
 To use the virtio-blk device, use the following virtio command::
 
-   -s <slot>,virtio-blk,<filepath>
+   -s <slot>,virtio-blk,<filepath>[,options]
+   
+   options:
+
+   writethru: write operation is reported completed only when the
+   data has been written to physical storage.
+
+   writeback: write operation is reported completed when data is
+   placed in page cache. Needs to be flushed to the physical storage.
+
+   ro: open file with readonly mode.
+
+   sectorsize:
+   1> sectorsize=<sector size>/<physical sector size>
+   2> sectorsize=<sector size>
+   default values for sector size and physical sector size are 512
+
+   range:
+   range=<start lba in file>/<sub file size>
 
 Successful booting of the User OS verifies the correctness of the
 device.