path: root/networking/using_networking_rtems_app.rst
diff options
authorMartin Erik Werner <>2019-09-03 01:48:28 +0200
committerChris Johns <>2019-09-03 09:48:35 +1000
commit2e711f2b4b59398a18d21ea34bdb064c459fdd45 (patch)
treee79c0d7ee12a966fdd93d717ec573657ea1e55ce /networking/using_networking_rtems_app.rst
parentb836c43f190cb731dc13cfa786e8ea66fa10e584 (diff)
Address several issues from compiling examples
Compiling the code from examples "code-block:: c" along with public includes and a bsp exposed a few issues amongst a lot of false positives. Address some of these: * Terminate struct declarations with ';'. Mainly for pedantic correctness. * Show ptrdiff_t instead of size_t for the sbrk() prototype, matching the current argument type in rtems. * Replace some occurrences of unsigned16 with uint16_t. * Fix odd type declaration, "uint8_t char*" -> "char*". * Use appropriate helper to get chain head instead of invalid access to nonexistent struct member. * Remove several excess '\' escapes. * Use RTEMS_SELF instead of undefined SELF. * Use rtems_task instead of void for task functions. * Add missing stack size parameter in task creation. * Use rtems_interrupt_level instead of undefined rtems_interrupt. * Correct return value format for rtems_object_id_get_api() rtems_object_id_get_index() (enum and uint16_t) and also fix corresponding print formatting. * Correct return value documentation for rtems_object_id_get_class(), rtems_object_id_get_node() and rtems_object_id_get_index() int -> uint32_t. * Use RTEMS_SUCCESSFUL instead of undefined RTEMS_STATUS_SUCCESSFUL and fix return value variable name in rate monotonic examples. * Use RTEMS_TIMEOUT instead of undefined TIMEOUT and RTEMS_PERIOD_STATUS instead of undefined STATUS. * Add missing fields to ftpd configuration. * Correct parameter types in ftpd hook prototype, unsigned char * -> void *. * Fix various code-block:: attributes, c -> makefile and c -> shell. * Add missing parenthesis in socket buffer memory calculation example. * Remove typedef in declaration of mq_attr since it is defiend without typedef in reality. * Update siginfo_t declaration to match current reality. * Update shell user command definition example to include mode, uid and gid.
Diffstat (limited to 'networking/using_networking_rtems_app.rst')
1 files changed, 3 insertions, 3 deletions
diff --git a/networking/using_networking_rtems_app.rst b/networking/using_networking_rtems_app.rst
index 3d117dc..0d3e245 100644
--- a/networking/using_networking_rtems_app.rst
+++ b/networking/using_networking_rtems_app.rst
@@ -14,7 +14,7 @@ Including the required managers
The FreeBSD networking code requires several RTEMS managers in the application:
-.. code-block:: c
+.. code-block:: makefile
MANAGERS = io event semaphore
@@ -25,7 +25,7 @@ The networking tasks allocate a lot of memory. For most applications the heap
should be at least 256 kbytes. The amount of memory set aside for the heap can
be adjusted by setting the ``CFLAGS_LD`` definition as shown below:
-.. code-block:: c
+.. code-block:: makefile
CFLAGS_LD += -Wl,--defsym -Wl,HeapSize=0x80000
@@ -210,7 +210,7 @@ the first two entries in this structure.
.. code-block:: c
- 40 * (1024 + sizeof(struct sockaddr_in)
+ 40 * (1024 + sizeof(struct sockaddr_in))
``unsigned long tcp_tx_buf_size``
This configuration parameter specifies the maximum amount of buffer memory