You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/03/04 01:55:16 UTC
incubator-mynewt-site git commit: shell functions added. mbuf split
up. This closes #24.
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master c9bd0d5a8 -> 74514067b
shell functions added. mbuf split up. This closes #24.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/74514067
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/74514067
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/74514067
Branch: refs/heads/master
Commit: 74514067b4bcbfe37bdfa3c36da1bf72df8f2630
Parents: c9bd0d5
Author: aditihilbert <ad...@runtime.io>
Authored: Thu Mar 3 16:55:09 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Thu Mar 3 16:55:09 2016 -0800
----------------------------------------------------------------------
docs/os/core_os/mbuf/os_msys_get.md | 46 ------------
docs/os/core_os/mbuf/os_msys_get_pkthdr.md | 48 ------------
docs/os/core_os/mbuf/os_msys_register.md | 35 ---------
docs/os/core_os/mbuf/os_msys_reset.md | 33 ---------
docs/os/core_os/msys/msys.md | 0
docs/os/core_os/msys/os_msys_get.md | 46 ++++++++++++
docs/os/core_os/msys/os_msys_get_pkthdr.md | 48 ++++++++++++
docs/os/core_os/msys/os_msys_register.md | 35 +++++++++
docs/os/core_os/msys/os_msys_reset.md | 33 +++++++++
docs/os/modules/shell/shell.md | 12 +--
docs/os/modules/shell/shell_cmd_register.md | 4 +-
.../modules/shell/shell_nlip_input_register.md | 2 +-
docs/os/modules/shell/shell_nlip_output.md | 2 +-
docs/os/modules/shell/shell_task_init.md | 3 +-
mkdocs.yml | 78 ++++++++++----------
15 files changed, 215 insertions(+), 210 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/mbuf/os_msys_get.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_msys_get.md b/docs/os/core_os/mbuf/os_msys_get.md
deleted file mode 100644
index 6b0c607..0000000
--- a/docs/os/core_os/mbuf/os_msys_get.md
+++ /dev/null
@@ -1,46 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt">os_msys_get</font>
-
-```no-highlight
-struct os_mbuf *os_msys_get(uint16_t dsize, uint16_t leadingspace)
-```
-
-Retrieve an mbuf from the system mbuf pools with *leadingspace* bytes available in the mbuf.
-
-<br>
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dsize | Minimum requested size of mbuf. Actual mbuf allocated may not accommodate *dsize* |
-| leadingspace | Number of bytes for leading space in mbuf (space at start of mbuf) |
-
-<br>
-
-#### Returned values
-Pointer to mbuf or NULL if no mbufs were available.
-
-<br>
-
-#### Notes
-As described in the overview section, `os_msys_get()` may return an mbuf that is smaller than dsize, meaning that the mbuf user data buffer does not have enough contiguous space to hold *dsize* bytes.
-
-This API will not return an mbuf from a larger mbuf pool if the appropriate msys mbuf pool is empty. See the overview for more information.
-
-<br>
-
-#### Example
-
-```no-highlight
- struct os_mbuf *om;
-
- /* Allocate an mbuf with hopefully at least 100 bytes in its user data buffer */
- om = os_msys_get(100, 0);
- if (!om) {
- /* No mbufs available. */
- return -1;
- }
-}
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/mbuf/os_msys_get_pkthdr.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_msys_get_pkthdr.md b/docs/os/core_os/mbuf/os_msys_get_pkthdr.md
deleted file mode 100644
index 12d2f1a..0000000
--- a/docs/os/core_os/mbuf/os_msys_get_pkthdr.md
+++ /dev/null
@@ -1,48 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt">os_msys_get_pkthdr</font>
-
-```no-highlight
-struct os_mbuf *os_msys_get_pkthdr(uint16_t dsize, uint16_t user_hdr_len)
-```
-
-Retrieve a packet header mbuf from the system mbuf pools with *user_hdr_len* bytes available for the user header in the mbuf.
-
-<br>
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| dsize | Minimum requested size of mbuf. Actual mbuf allocated may not accommodate *dsize* |
-| user_hdr_len | Size, in of bytes, of user header in the mbuf |
-
-<br>
-
-#### Returned values
-Pointer to mbuf or NULL if no mbufs were available.
-
-<br>
-
-#### Notes
-The same notes apply to this API as to `os_msys_get()`.
-
-<br>
-
-#### Example
-
-```no-highlight
- struct os_mbuf *om;
- struct my_user_hdr_struct my_usr_hdr;
-
- /*
- * Allocate an mbuf with hopefully at least 100 bytes in its user data buffer
- * and that has a user header of size sizeof(struct my_user_hdr_struct)
- */
- om = os_msys_get_pkthdr(100, sizeof(struct my_user_hdr_struct));
- if (!om) {
- /* No mbufs available. */
- return -1;
- }
-}
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/mbuf/os_msys_register.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_msys_register.md b/docs/os/core_os/mbuf/os_msys_register.md
deleted file mode 100644
index 8fb4257..0000000
--- a/docs/os/core_os/mbuf/os_msys_register.md
+++ /dev/null
@@ -1,35 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt">os_msys_register</font>
-
-```no-highlight
-int os_msys_register(struct os_mbuf_pool *new_pool)
-```
-
-Register an mbuf pool for use as a system mbuf pool. The pool should be initialized prior to registration.
-
-<br>
-
-#### Arguments
-
-| Arguments | Description |
-|-----------|-------------|
-| new_pool | Pointer to mbuf pool to add to system mbuf pools |
-
-<br>
-
-#### Returned values
-0 on success; all other values indicate an error.
-
-<br>
-
-#### Notes
-
-<br>
-
-#### Example
-
-```no-highlight
- rc = os_msys_register(&g_mbuf_pool);
- assert(rc == 0);
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/mbuf/os_msys_reset.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_msys_reset.md b/docs/os/core_os/mbuf/os_msys_reset.md
deleted file mode 100644
index 1ed5875..0000000
--- a/docs/os/core_os/mbuf/os_msys_reset.md
+++ /dev/null
@@ -1,33 +0,0 @@
-## <font color="#F2853F" style="font-size:24pt">os_msys_reset</font>
-
-```no-highlight
-void os_msys_reset(void)
-```
-
-Resets msys module. This de-registers all pools from msys but does nothing to the pools themselves (they still exist as mbuf pools).
-
-<br>
-
-#### Arguments
-
-None
-
-<br>
-
-#### Returned values
-
-None
-
-<br>
-
-#### Notes
-
-<br>
-
-#### Example
-
-```no-highlight
- os_msys_reset();
-```
-
----------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/msys/msys.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/msys.md b/docs/os/core_os/msys/msys.md
new file mode 100644
index 0000000..e69de29
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/msys/os_msys_get.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_get.md b/docs/os/core_os/msys/os_msys_get.md
new file mode 100644
index 0000000..6b0c607
--- /dev/null
+++ b/docs/os/core_os/msys/os_msys_get.md
@@ -0,0 +1,46 @@
+## <font color="#F2853F" style="font-size:24pt">os_msys_get</font>
+
+```no-highlight
+struct os_mbuf *os_msys_get(uint16_t dsize, uint16_t leadingspace)
+```
+
+Retrieve an mbuf from the system mbuf pools with *leadingspace* bytes available in the mbuf.
+
+<br>
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| dsize | Minimum requested size of mbuf. Actual mbuf allocated may not accommodate *dsize* |
+| leadingspace | Number of bytes for leading space in mbuf (space at start of mbuf) |
+
+<br>
+
+#### Returned values
+Pointer to mbuf or NULL if no mbufs were available.
+
+<br>
+
+#### Notes
+As described in the overview section, `os_msys_get()` may return an mbuf that is smaller than dsize, meaning that the mbuf user data buffer does not have enough contiguous space to hold *dsize* bytes.
+
+This API will not return an mbuf from a larger mbuf pool if the appropriate msys mbuf pool is empty. See the overview for more information.
+
+<br>
+
+#### Example
+
+```no-highlight
+ struct os_mbuf *om;
+
+ /* Allocate an mbuf with hopefully at least 100 bytes in its user data buffer */
+ om = os_msys_get(100, 0);
+ if (!om) {
+ /* No mbufs available. */
+ return -1;
+ }
+}
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/msys/os_msys_get_pkthdr.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_get_pkthdr.md b/docs/os/core_os/msys/os_msys_get_pkthdr.md
new file mode 100644
index 0000000..12d2f1a
--- /dev/null
+++ b/docs/os/core_os/msys/os_msys_get_pkthdr.md
@@ -0,0 +1,48 @@
+## <font color="#F2853F" style="font-size:24pt">os_msys_get_pkthdr</font>
+
+```no-highlight
+struct os_mbuf *os_msys_get_pkthdr(uint16_t dsize, uint16_t user_hdr_len)
+```
+
+Retrieve a packet header mbuf from the system mbuf pools with *user_hdr_len* bytes available for the user header in the mbuf.
+
+<br>
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| dsize | Minimum requested size of mbuf. Actual mbuf allocated may not accommodate *dsize* |
+| user_hdr_len | Size, in of bytes, of user header in the mbuf |
+
+<br>
+
+#### Returned values
+Pointer to mbuf or NULL if no mbufs were available.
+
+<br>
+
+#### Notes
+The same notes apply to this API as to `os_msys_get()`.
+
+<br>
+
+#### Example
+
+```no-highlight
+ struct os_mbuf *om;
+ struct my_user_hdr_struct my_usr_hdr;
+
+ /*
+ * Allocate an mbuf with hopefully at least 100 bytes in its user data buffer
+ * and that has a user header of size sizeof(struct my_user_hdr_struct)
+ */
+ om = os_msys_get_pkthdr(100, sizeof(struct my_user_hdr_struct));
+ if (!om) {
+ /* No mbufs available. */
+ return -1;
+ }
+}
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/msys/os_msys_register.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_register.md b/docs/os/core_os/msys/os_msys_register.md
new file mode 100644
index 0000000..8fb4257
--- /dev/null
+++ b/docs/os/core_os/msys/os_msys_register.md
@@ -0,0 +1,35 @@
+## <font color="#F2853F" style="font-size:24pt">os_msys_register</font>
+
+```no-highlight
+int os_msys_register(struct os_mbuf_pool *new_pool)
+```
+
+Register an mbuf pool for use as a system mbuf pool. The pool should be initialized prior to registration.
+
+<br>
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| new_pool | Pointer to mbuf pool to add to system mbuf pools |
+
+<br>
+
+#### Returned values
+0 on success; all other values indicate an error.
+
+<br>
+
+#### Notes
+
+<br>
+
+#### Example
+
+```no-highlight
+ rc = os_msys_register(&g_mbuf_pool);
+ assert(rc == 0);
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/core_os/msys/os_msys_reset.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/msys/os_msys_reset.md b/docs/os/core_os/msys/os_msys_reset.md
new file mode 100644
index 0000000..1ed5875
--- /dev/null
+++ b/docs/os/core_os/msys/os_msys_reset.md
@@ -0,0 +1,33 @@
+## <font color="#F2853F" style="font-size:24pt">os_msys_reset</font>
+
+```no-highlight
+void os_msys_reset(void)
+```
+
+Resets msys module. This de-registers all pools from msys but does nothing to the pools themselves (they still exist as mbuf pools).
+
+<br>
+
+#### Arguments
+
+None
+
+<br>
+
+#### Returned values
+
+None
+
+<br>
+
+#### Notes
+
+<br>
+
+#### Example
+
+```no-highlight
+ os_msys_reset();
+```
+
+---------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/modules/shell/shell.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell.md b/docs/os/modules/shell/shell.md
index e8a43c6..94034a5 100644
--- a/docs/os/modules/shell/shell.md
+++ b/docs/os/modules/shell/shell.md
@@ -1,16 +1,18 @@
# Shell
-The shell is package sitting on top of console, handling 2 jobs; processing console input and implementing newtmgr line protocol over serial line. Shell runs on it's own task.
+The shell is package sitting on top of console, handling 2 jobs: processing console input and implementing newtmgr line protocol over serial line. Shell runs on its own task.
## Description
-First job is directing incoming commands to other subsystems. It parses the incoming character string, and splits it into tokens. Then shell looks for the subsystem to handle this command based on the first token of input.
+* Shell's first job is directing incoming commands to other subsystems. It parses the incoming character string, and splits it into tokens. Then it looks for the subsystem to handle this command based on the first token of input.
-Subsystems register their command handlers using *shell_cmd_register()*. When shell calls the command handler, it passes the other tokens as arguments.
+ Subsystems register their command handlers using `shell_cmd_register()`. When shell calls the command handler, it passes the other tokens as arguments.
-A few commands are currently available in the shell - `tasks`, `log`, and `stat stat`. A $ prompt sign will be coming soon!
+ A few commands are currently available in the shell - `tasks`, `log`, and `stat stat`. A $ prompt sign will be coming soon!
-Second job is doing framing, encoding and decoding newtmgr protocol when it's carried over the console. Protocol handler (libs/newtmgr) registers itself using *shell_nlip_input_register()*, and shell calls the registered handler for every frame. Outgoing frames for the protocol are sent using *shell_nlip_output()*.
+* Shell's second job is doing framing, encoding and decoding newtmgr protocol when it's carried over the console. Protocol handler (libs/newtmgr) registers itself using `shell_nlip_input_register()`, and shell calls the registered handler for every frame. Outgoing frames for the protocol are sent using `shell_nlip_output()`.
+
+<br>
Create a sim target to check out these commands available in shell.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/modules/shell/shell_cmd_register.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell_cmd_register.md b/docs/os/modules/shell/shell_cmd_register.md
index 10be89e..aea4c16 100644
--- a/docs/os/modules/shell/shell_cmd_register.md
+++ b/docs/os/modules/shell/shell_cmd_register.md
@@ -4,9 +4,9 @@
int shell_cmd_register(struct shell_cmd *sc)
```
-Registers a handler for incoming console commands. Within the structure there is the command string, and the handler for those commands. Caller must allocate the memory for this structure, and keep it around, as shell links this to it's own internal data structures.
+Registers a handler for incoming console commands. Within the structure there is the command string and the handler for those commands. Caller must allocate the memory for this structure and keep it around as shell links this to its own internal data structures.
-Command handler is of type 'int (*shell_cmd_func_t)(int argc, char **argv)'. Command line arguments are passed to it as an array of character pointers.
+Command handler is of type `int(*shell_cmd_func_t)(int argc, char **argv)`. Command line arguments are passed to it as an array of character pointers.
#### Arguments
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/modules/shell/shell_nlip_input_register.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell_nlip_input_register.md b/docs/os/modules/shell/shell_nlip_input_register.md
index 544f422..abc64d6 100644
--- a/docs/os/modules/shell/shell_nlip_input_register.md
+++ b/docs/os/modules/shell/shell_nlip_input_register.md
@@ -4,7 +4,7 @@
int shell_nlip_input_register(shell_nlip_input_func_t nf, void *arg)
```
-Registers a handler for incoming newtmgr messages. Shell receives incoming data stream from UART, and when it detects NLIP frame, it decodes it and passes it on by calling the function *nf*.
+Registers a handler for incoming newtmgr messages. Shell receives incoming data stream from UART and when it detects NLIP frame, it decodes it and passes it on by calling the function `nf`.
Handler function is of type `int (*shell_nlip_input_func_t)(struct os_mbuf *m, void *arg)`. Shell passes the incoming newtmgr message inside os_mbuf *m*, and *arg* is the argument that was passed in during handler registration.
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/modules/shell/shell_nlip_output.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell_nlip_output.md b/docs/os/modules/shell/shell_nlip_output.md
index 2fad92f..4880de0 100644
--- a/docs/os/modules/shell/shell_nlip_output.md
+++ b/docs/os/modules/shell/shell_nlip_output.md
@@ -4,7 +4,7 @@
int shell_nlip_output(struct os_mbuf *m)
```
-Queue outgoing newtmgr message for transmission. Shell package will encode this, and frame it while sending it out via console.
+Queue outgoing newtmgr message for transmission. Shell package will encode this and frame it while sending it out via console.
#### Arguments
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/docs/os/modules/shell/shell_task_init.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/shell/shell_task_init.md b/docs/os/modules/shell/shell_task_init.md
index fe765b6..ce2985a 100644
--- a/docs/os/modules/shell/shell_task_init.md
+++ b/docs/os/modules/shell/shell_task_init.md
@@ -5,8 +5,7 @@ int shell_task_init(uint8_t prio, os_stack_t *stack, uint16_t stack_size,
int max_input_length);
```
-Initializes the shell package. This creates a task for shell, and registers few commands on it's own (*echo*, *?*, for example).
-It also allocates memory for buffering console input.
+Initializes the shell package. This creates a task for shell, and registers few commands on its own (*echo*, *?*, for example). It also allocates memory for buffering console input.
#### Arguments
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/74514067/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 532631f..488ba08 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -90,42 +90,46 @@ pages:
- 'os_free': 'os/core_os/heap/os_free.md'
- 'os_malloc': 'os/core_os/heap/os_malloc.md'
- 'os_realloc': 'os/core_os/heap/os_realloc.md'
- - Mbufs:
- - 'Overview': 'os/core_os/mbuf/mbuf.md'
- - 'Functions/Macros':
- - 'OS_MBUF_PKTHDR': 'os/core_os/mbuf/OS_MBUF_PKTHDR.md'
- - 'OS_MBUF_PKTHDR_TO_MBUF': 'os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md'
- - 'OS_MBUF_PKTLEN': 'os/core_os/mbuf/OS_MBUF_PKTLEN.md'
- - 'OS_MBUF_DATA': 'os/core_os/mbuf/OS_MBUF_DATA.md'
- - 'OS_MBUF_USRHDR': 'os/core_os/mbuf/OS_MBUF_USRHDR.md'
- - 'OS_MBUF_USRHDR_LEN': 'os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md'
- - 'OS_MBUF_LEADINGSPACE': 'os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md'
- - 'OS_MBUF_TRAILINGSPACE': 'os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md'
- - 'os_mbuf_adj': 'os/core_os/mbuf/os_mbuf_adj.md'
- - 'os_mbuf_append': 'os/core_os/mbuf/os_mbuf_append.md'
- - 'os_mbuf_concat': 'os/core_os/mbuf/os_mbuf_concat.md'
- - 'os_mbuf_copydata': 'os/core_os/mbuf/os_mbuf_copydata.md'
- - 'os_mbuf_copyinto': 'os/core_os/mbuf/os_mbuf_copyinto.md'
- - 'os_mbuf_dup': 'os/core_os/mbuf/os_mbuf_dup.md'
- - 'os_mbuf_extend': 'os/core_os/mbuf/os_mbuf_extend.md'
- - 'os_mbuf_free_chain': 'os/core_os/mbuf/os_mbuf_free_chain.md'
- - 'os_mbuf_get': 'os/core_os/mbuf/os_mbuf_get.md'
- - 'os_mbuf_get_pkthdr': 'os/core_os/mbuf/os_mbuf_get_pkthdr.md'
- - 'os_mbuf_memcmp': 'os/core_os/mbuf/os_mbuf_memcmp.md'
- - 'os_mbuf_off': 'os/core_os/mbuf/os_mbuf_off.md'
- - 'os_mbuf_pool_init': 'os/core_os/mbuf/os_mbuf_pool_init.md'
- - 'os_mbuf_prepend': 'os/core_os/mbuf/os_mbuf_prepend.md'
- - 'os_mbuf_pullup': 'os/core_os/mbuf/os_mbuf_pullup.md'
- - 'os_msys_get': 'os/core_os/mbuf/os_msys_get.md'
- - 'os_msys_get_pkthdr': 'os/core_os/mbuf/os_msys_get_pkthdr.md'
- - 'os_msys_register': 'os/core_os/mbuf/os_msys_register.md'
- - 'os_msys_reset': 'os/core_os/mbuf/os_msys_reset.md'
- - MQueue:
- - 'Overview': 'os/core_os/mqueue/mqueue.md'
- - Functions:
- - 'os_mqueue_get': 'os/core_os/mqueue/os_mqueue_get.md'
- - 'os_mqueue_init': 'os/core_os/mqueue/os_mqueue_init.md'
- - 'os_mqueue_put': 'os/core_os/mqueue/os_mqueue_put.md'
+ - Memory Buffers:
+ - Mbuf:
+ - 'Overview': 'os/core_os/mbuf/mbuf.md'
+ - 'Functions/Macros':
+ - 'OS_MBUF_PKTHDR': 'os/core_os/mbuf/OS_MBUF_PKTHDR.md'
+ - 'OS_MBUF_PKTHDR_TO_MBUF': 'os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md'
+ - 'OS_MBUF_PKTLEN': 'os/core_os/mbuf/OS_MBUF_PKTLEN.md'
+ - 'OS_MBUF_DATA': 'os/core_os/mbuf/OS_MBUF_DATA.md'
+ - 'OS_MBUF_USRHDR': 'os/core_os/mbuf/OS_MBUF_USRHDR.md'
+ - 'OS_MBUF_USRHDR_LEN': 'os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md'
+ - 'OS_MBUF_LEADINGSPACE': 'os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md'
+ - 'OS_MBUF_TRAILINGSPACE': 'os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md'
+ - 'os_mbuf_adj': 'os/core_os/mbuf/os_mbuf_adj.md'
+ - 'os_mbuf_append': 'os/core_os/mbuf/os_mbuf_append.md'
+ - 'os_mbuf_concat': 'os/core_os/mbuf/os_mbuf_concat.md'
+ - 'os_mbuf_copydata': 'os/core_os/mbuf/os_mbuf_copydata.md'
+ - 'os_mbuf_copyinto': 'os/core_os/mbuf/os_mbuf_copyinto.md'
+ - 'os_mbuf_dup': 'os/core_os/mbuf/os_mbuf_dup.md'
+ - 'os_mbuf_extend': 'os/core_os/mbuf/os_mbuf_extend.md'
+ - 'os_mbuf_free_chain': 'os/core_os/mbuf/os_mbuf_free_chain.md'
+ - 'os_mbuf_get': 'os/core_os/mbuf/os_mbuf_get.md'
+ - 'os_mbuf_get_pkthdr': 'os/core_os/mbuf/os_mbuf_get_pkthdr.md'
+ - 'os_mbuf_memcmp': 'os/core_os/mbuf/os_mbuf_memcmp.md'
+ - 'os_mbuf_off': 'os/core_os/mbuf/os_mbuf_off.md'
+ - 'os_mbuf_pool_init': 'os/core_os/mbuf/os_mbuf_pool_init.md'
+ - 'os_mbuf_prepend': 'os/core_os/mbuf/os_mbuf_prepend.md'
+ - 'os_mbuf_pullup': 'os/core_os/mbuf/os_mbuf_pullup.md'
+ - Msys:
+ - 'Overview': 'os/core_os/msys/msys.md'
+ - 'Functions':
+ - 'os_msys_get': 'os/core_os/msys/os_msys_get.md'
+ - 'os_msys_get_pkthdr': 'os/core_os/msys/os_msys_get_pkthdr.md'
+ - 'os_msys_register': 'os/core_os/msys/os_msys_register.md'
+ - 'os_msys_reset': 'os/core_os/msys/os_msys_reset.md'
+ - MQueue:
+ - 'Overview': 'os/core_os/mqueue/mqueue.md'
+ - Functions:
+ - 'os_mqueue_get': 'os/core_os/mqueue/os_mqueue_get.md'
+ - 'os_mqueue_init': 'os/core_os/mqueue/os_mqueue_init.md'
+ - 'os_mqueue_put': 'os/core_os/mqueue/os_mqueue_put.md'
- Sanity:
- 'Overview': 'os/core_os/sanity/sanity.md'
- 'Functions':
@@ -156,10 +160,10 @@ pages:
- Shell:
- 'Overview': 'os/modules/shell/shell.md'
- 'Functions':
+ - 'shell_task_init': 'os/modules/shell/shell_task_init.md'
- 'shell_cmd_register': 'os/modules/shell/shell_cmd_register.md'
- 'shell_nlip_input_register': 'os/modules/shell/shell_nlip_input_register.md'
- 'shell_nlip_output': 'os/modules/shell/shell_nlip_output.md'
- - 'shell_task_init': 'os/modules/shell/shell_task_init.md'
- Bootloader:
- 'Overview': 'os/modules/bootloader/bootloader.md'
- 'Functions':