From affa05532dddf8cc0a1bdb452a7555cc7f9dc691 Mon Sep 17 00:00:00 2001
From: Jieqiang Wang <jieqiang.wang@arm.com>
Date: Tue, 22 Oct 2019 20:09:16 +0800
Subject: docs: add physmem section in configuration parameters

physmem section is listed in 'Advanced Parameters', which has two
parameters, base-addr and max-size, for pmalloc module in VPP.

Type:feature

Change-Id: I7beef40603b864e4c8f3cf0fa716de74036cfdcc
Signed-off-by: Jieqiang Wang <jieqiang.wang@arm.com>
---
 docs/gettingstarted/users/configuring/startup.rst | 34 ++++++++++++++++++++---
 1 file changed, 30 insertions(+), 4 deletions(-)

(limited to 'docs/gettingstarted')

diff --git a/docs/gettingstarted/users/configuring/startup.rst b/docs/gettingstarted/users/configuring/startup.rst
index 6ec2b97e219..51a22f08c55 100644
--- a/docs/gettingstarted/users/configuring/startup.rst
+++ b/docs/gettingstarted/users/configuring/startup.rst
@@ -1328,7 +1328,7 @@ meaning the NAT is not deterministic.
    deterministic
 
 nat64 bib hash buckets <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the number of hash buckets in each of the two in/out NAT64 BIB bi-hash
 tables. Defaults to 1024 buckets.
@@ -1338,7 +1338,7 @@ tables. Defaults to 1024 buckets.
    nat64 bib hash buckets 1024
 
 nat64 bib hash memory <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the allocated memory size (in bytes) for each of the two in/out NAT64
 BIB bi-hash tables. Defaults to 134217728 (128 << 20) bytes,
@@ -1349,7 +1349,7 @@ which is roughly 128 MB.
    nat64 bib hash memory 134217728
 
 nat64 st hash buckets <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the number of hash buckets in each of the two in/out NAT64 session table
 bi-hash tables. Defaults to 2048 buckets.
@@ -1359,7 +1359,7 @@ bi-hash tables. Defaults to 2048 buckets.
    nat64 st hash buckets 2048
 
 nat64 st hash memory <n>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^
 
 Sets the allocated memory size (in bytes) for each of the two in/out NAT64 session
 table bi-hash tables. Defaults to 268435456 (256 << 20) bytes, which is roughly
@@ -1397,6 +1397,32 @@ Default is 2.04 seconds.
 
    interval 3.5
 
+physmem Section
+---------------
+
+Configuration parameters used to specify base address and maximum size of
+the memory allocated for the pmalloc module in VPP. pmalloc is a NUMA-aware,
+growable physical memory allocator. pmalloc allocates memory for the DPDK
+memory pool.
+
+base-addr <address>
+^^^^^^^^^^^^^^^^^^^
+
+Specify the base address for pmalloc memory space.
+
+.. code-block:: console
+
+    base-addr 0xfffe00000000
+
+max-size <n>G | <n>M | <n>K | <n>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Set the memory size for pmalloc memory space. The default is 16G.
+
+.. code-block:: console
+
+    max-size 4G
+
 tapcli Section
 --------------
 
-- 
cgit 1.2.3-korg