[rtems commit] doc: Document network task affinity option

[Daniel Hellstrom]

Module:    rtems
Branch:    master
Commit:    8244a2f4476abb2db830bcf54dc4faea6452ec4c
Changeset: http://git.rtems.org/rtems/commit/?id=8244a2f4476abb2db830bcf54dc4faea6452ec4c

Author:    Daniel Cederman <cederman at gaisler.com>
Date:      Mon Jan 12 11:24:58 2015 +0100

doc: Document network task affinity option

---

 doc/networking/networkapp.t | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/doc/networking/networkapp.t b/doc/networking/networkapp.t
index 62b1a53..dd356a8 100644
--- a/doc/networking/networkapp.t
+++ b/doc/networking/networkapp.t
@@ -101,6 +101,11 @@ struct rtems_bsdnet_config @{
   unsigned long        tcp_tx_buf_size;
   /* TCP TX: 16 * 1024 bytes */
   unsigned long        tcp_rx_buf_size;
+  /* Default Network Tasks CPU Affinity */
+#ifdef RTEMS_SMP
+  const cpu_set_t     *network_task_cpuset;
+  size_t               network_task_cpuset_size;
+#endif
 @};
 @end group
 @end example
@@ -229,6 +234,15 @@ This configuration parameter specifies the maximum amount of
 buffer memory which may be used for TCP sockets to receive
 into.  The default size is sixteen kilobytes.
 
+ at item const cpu_set_t *network_task_cpuset
+This configuration parameter specifies the CPU affinity of the
+network task. If set to @code{0} the network task can be scheduled on
+any CPU. Only available in SMP configurations.
+
+ at item size_t network_task_cpuset_size
+This configuration parameter specifies the size of the
+ at code{network_task_cpuset} used. Only available in SMP configurations.
+
 @end table
 
 In addition, the following fields in the @code{rtems_bsdnet_ifconfig}