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/11/15 19:34:47 UTC
[39/40] incubator-mynewt-site git commit: This closes #118.
This closes #118.
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/1720300a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/1720300a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/1720300a
Branch: refs/heads/master
Commit: 1720300a0a737871789ad678100b3e057a12341a
Parents: 870f609
Author: aditihilbert <ad...@runtime.io>
Authored: Tue Nov 15 11:14:53 2016 -0800
Committer: aditihilbert <ad...@runtime.io>
Committed: Tue Nov 15 11:14:53 2016 -0800
----------------------------------------------------------------------
docs/about.md | 11 +-
docs/faq/how_to_edit_docs.md | 7 +-
docs/network/ble/ble_intro.md | 43 ++--
docs/newt/install/newt_linux.md | 4 +-
docs/os/core_os/callout/callout.md | 20 +-
docs/os/core_os/callout/os_callout_func_init.md | 20 +-
docs/os/core_os/callout/os_callout_init.md | 16 +-
docs/os/core_os/callout/os_callout_queued.md | 7 +-
docs/os/core_os/callout/os_callout_reset.md | 12 +-
docs/os/core_os/callout/os_callout_stop.md | 10 +-
.../os/core_os/context_switch/context_switch.md | 20 +-
.../os/core_os/context_switch/os_arch_ctx_sw.md | 10 +-
docs/os/core_os/context_switch/os_sched.md | 6 +-
.../context_switch/os_sched_ctx_sw_hook.md | 2 +-
.../core_os/context_switch/os_sched_insert.md | 7 +-
.../context_switch/os_sched_os_timer_exp.md | 4 +-
.../core_os/context_switch/os_sched_resort.md | 6 +-
.../context_switch/os_sched_set_current_task.md | 6 +-
.../os/core_os/context_switch/os_sched_sleep.md | 10 +-
.../core_os/context_switch/os_sched_wakeup.md | 2 +-
docs/os/core_os/event_queue/event_queue.md | 16 +-
docs/os/core_os/event_queue/os_eventq_get.md | 4 +-
docs/os/core_os/event_queue/os_eventq_init.md | 4 +-
docs/os/core_os/event_queue/os_eventq_put.md | 6 +-
docs/os/core_os/event_queue/os_eventq_remove.md | 6 +-
docs/os/core_os/heap/heap.md | 2 +-
docs/os/core_os/heap/os_free.md | 4 +-
docs/os/core_os/heap/os_malloc.md | 12 +-
docs/os/core_os/heap/os_realloc.md | 10 +-
docs/os/core_os/mbuf/OS_MBUF_DATA.md | 4 +-
docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md | 4 +-
docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md | 2 +-
docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md | 2 +-
docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md | 2 +-
docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md | 4 +-
docs/os/core_os/mbuf/OS_MBUF_USRHDR.md | 2 +-
docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md | 2 +-
docs/os/core_os/mbuf/mbuf.md | 26 +--
docs/os/core_os/mbuf/os_mbuf_adj.md | 6 +-
docs/os/core_os/mbuf/os_mbuf_append.md | 14 +-
docs/os/core_os/mbuf/os_mbuf_concat.md | 4 +-
docs/os/core_os/mbuf/os_mbuf_copydata.md | 10 +-
docs/os/core_os/mbuf/os_mbuf_copyinto.md | 8 +-
docs/os/core_os/mbuf/os_mbuf_dup.md | 4 +-
docs/os/core_os/mbuf/os_mbuf_extend.md | 8 +-
docs/os/core_os/mbuf/os_mbuf_free_chain.md | 2 +-
docs/os/core_os/mbuf/os_mbuf_get.md | 8 +-
docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md | 10 +-
docs/os/core_os/mbuf/os_mbuf_memcmp.md | 10 +-
docs/os/core_os/mbuf/os_mbuf_off.md | 12 +-
docs/os/core_os/mbuf/os_mbuf_pool_init.md | 10 +-
docs/os/core_os/mbuf/os_mbuf_prepend.md | 8 +-
docs/os/core_os/mbuf/os_mbuf_pullup.md | 8 +-
docs/os/core_os/memory_pool/OS_MEMPOOL_BYTES.md | 8 +-
docs/os/core_os/memory_pool/OS_MEMPOOL_SIZE.md | 16 +-
docs/os/core_os/memory_pool/memory_pool.md | 2 +-
docs/os/core_os/memory_pool/os_memblock_get.md | 6 +-
docs/os/core_os/memory_pool/os_memblock_put.md | 8 +-
docs/os/core_os/memory_pool/os_mempool_init.md | 26 +--
docs/os/core_os/mqueue/mqueue.md | 6 +-
docs/os/core_os/mqueue/os_mqueue_get.md | 6 +-
docs/os/core_os/mqueue/os_mqueue_init.md | 6 +-
docs/os/core_os/mqueue/os_mqueue_put.md | 10 +-
docs/os/core_os/msys/msys.md | 4 +-
docs/os/core_os/msys/os_msys_get.md | 10 +-
docs/os/core_os/msys/os_msys_get_pkthdr.md | 8 +-
docs/os/core_os/msys/os_msys_register.md | 2 +-
docs/os/core_os/mutex/mutex.md | 2 +-
docs/os/core_os/mutex/os_mutex_init.md | 6 +-
docs/os/core_os/mutex/os_mutex_pend.md | 14 +-
docs/os/core_os/mutex/os_mutex_release.md | 10 +-
docs/os/core_os/mynewt_os.md | 8 +-
docs/os/core_os/os_init.md | 6 +-
docs/os/core_os/os_start.md | 4 +-
docs/os/core_os/os_started.md | 6 +-
docs/os/core_os/porting/port_bsp.md | 112 ++++------
docs/os/core_os/porting/port_cpu.md | 20 +-
docs/os/core_os/porting/port_mcu.md | 9 +-
docs/os/core_os/porting/port_os.md | 24 +-
docs/os/core_os/sanity/sanity.md | 2 +-
docs/os/core_os/semaphore/os_sem_init.md | 8 +-
docs/os/core_os/semaphore/os_sem_pend.md | 14 +-
docs/os/core_os/semaphore/os_sem_release.md | 8 +-
docs/os/core_os/semaphore/semaphore.md | 8 +-
docs/os/core_os/task/os_task_info_get_next.md | 18 +-
docs/os/core_os/task/os_task_init.md | 20 +-
docs/os/core_os/task/task.md | 15 +-
docs/os/core_os/time/os_gettimeofday.md | 4 +-
docs/os/core_os/time/os_settimeofday.md | 4 +-
docs/os/core_os/time/os_time.md | 12 +-
docs/os/core_os/time/os_time_delay.md | 2 +-
docs/os/get_started/cross_tools.md | 4 +-
docs/os/get_started/project_create.md | 108 +++------
docs/os/get_started/vocabulary.md | 67 ++----
docs/os/modules/baselibc.md | 21 +-
docs/os/modules/bootloader/bootloader.md | 218 +++----------------
docs/os/modules/console/console.md | 37 +---
.../os/modules/console/console_blocking_mode.md | 12 +-
docs/os/modules/console/console_echo.md | 13 +-
docs/os/modules/console/console_init.md | 18 +-
docs/os/modules/console/console_is_init.md | 8 +-
docs/os/modules/console/console_printf.md | 22 +-
docs/os/modules/console/console_read.md | 18 +-
docs/os/modules/console/console_write.md | 11 +-
docs/os/modules/shell/shell.md | 30 +--
docs/os/modules/shell/shell_cmd_register.md | 13 +-
.../modules/shell/shell_nlip_input_register.md | 15 +-
docs/os/modules/shell/shell_nlip_output.md | 6 +-
docs/os/modules/shell/shell_task_init.md | 18 +-
docs/os/tutorials/STM32F303.md | 6 +-
docs/os/tutorials/arduino_zero.md | 117 ++--------
docs/os/tutorials/bleprph/bleprph-conn.md | 156 +++++++++++++
docs/os/tutorials/bletiny_project.md | 135 +++++-------
docs/os/tutorials/nRF52.md | 16 +-
docs/os/tutorials/repo/add_repos.md | 14 +-
docs/os/tutorials/repo/create_repo.md | 40 +---
docs/os/tutorials/repo/upgrade_repo.md | 4 -
mkdocs.yml | 5 +-
118 files changed, 863 insertions(+), 1180 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/about.md
----------------------------------------------------------------------
diff --git a/docs/about.md b/docs/about.md
index 6f0606b..a842db4 100644
--- a/docs/about.md
+++ b/docs/about.md
@@ -2,11 +2,12 @@
Some upcoming features:
-* Full IP support
-* Low power support with ability for drivers to turn on/off low power settings automatically
-* Sensor API, see [discussion thread](https://lists.apache.org/list.html?dev@mynewt.apache.org:dfr=June%201|dto=2016-11-14:%22Sensor%20Drivers%22)
-* Support for MIPS architecture
-* Support for additional boards
+* Host-only BLE stack
+* Serial upgrade of image in bootloader
+* HAL redesign to abstract across a diverse set of chip peripherals ([View discussion thread](http://mail-archives.apache.org/mod_mbox/incubator-mynewt-dev/201606.mbox/%3C06CB0682-8F67-4C3F-93E4-6A20444487A1%40apache.org%3E))
+* HAL for SPI access (master and slave)
+* Ability for drivers to turn on/off low power settings automatically
+
<font color="#F2853F"> The detailed roadmap is tracked on [JIRA for Mynewt](https://issues.apache.org/jira/browse/MYNEWT/?selectedTab=com.atlassian.jira.jira-projects-plugin:roadmap-panel). </font>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/faq/how_to_edit_docs.md
----------------------------------------------------------------------
diff --git a/docs/faq/how_to_edit_docs.md b/docs/faq/how_to_edit_docs.md
index bd7e2e6..b3229c6 100644
--- a/docs/faq/how_to_edit_docs.md
+++ b/docs/faq/how_to_edit_docs.md
@@ -19,8 +19,9 @@ If you are not a committer, you may follow the proposed non-committer workflow t
### Editing an existing page
-* Create a fork on the [github mirror](https://github.com/apache/incubator-mynewt-site).
-* Create a new branch to work on your documentation and move to that branch.
+* Create a fork on the [github mirror](https://github.com/apache/incubator-mynewt-site).
+*
+* Then create a new branch to work on your documentation and move to that branch.
```
$ git checkout -b <your-branch-name>
```
@@ -50,6 +51,6 @@ You will then run the built-in webserver from the root of the documentation dire
docs images mkdocs.yml
$ mkdocs serve
```
-Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website. **Remember that the [MyNewt website](https://mynewt.apache.org) itself will not be updated.**
+Then go to [http://127.0.0.1:8000](http://127.0.0.1:8000) to preview your pages and see how they will look on the website. **Remember that the Myself website itself will not be updated.**
For more information on MkDocs go to [http://www.mkdocs.org](http://www.mkdocs.org).
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/network/ble/ble_intro.md
----------------------------------------------------------------------
diff --git a/docs/network/ble/ble_intro.md b/docs/network/ble/ble_intro.md
index 2841fd6..96bfb07 100644
--- a/docs/network/ble/ble_intro.md
+++ b/docs/network/ble/ble_intro.md
@@ -1,20 +1,32 @@
## BLE Introduction
-Apache Mynewt offers the world's first fully open-source Bluetooth Low Energy (BLE) or Bluetooth Smart stack fully compliant with BLE 4.2 specifications. It is called NimBLE.
+Apache Mynewt offers the world's first fully open-source Bluetooth Low Energy (BLE) or Bluetooth Smart stack. It is called NimBLE.
BLE technology operates in the unlicensed industrial, scientific and medical (ISM) band at 2.4 to 2.485 GHz which is available in most countries. It uses a spread spectrum, frequency hopping, full-duplex signal. BLE FHSS employs 40 2-MHz-wide channels to ensure greater reliability over longer distances. It also features 0-dBm (1 mW) power output and a typical maximum range of 50 meters. Note that BLE is not compatible with standard Bluetooth.
<br>
-### Feature Support
+### Features
NimBLE complies with Bluetooth Core Specification 4.2 which introduces several new features that make it an ideal wireless technology for the Internet of Things (IoT).
-* LE Privacy 1.2 for frequent changes to the device address to make it difficult to track for outsiders
-* LE Secure Connections featuring FIPS-compliant algorithms.
-* LE Data Length Extension for higher throughput
-* **Coming Soon**: Assigning an Internet Protocol (IP) address (complaint with the IPv6 or 6LoWPAN standard) to a Bluetooth device through Internet Protocol Support Profile (IPSP)
-
+* LE Privacy 1.2 for frequent changes to the device address to make it difficult to track for outsiders **Roadmap**
+* LE Secure Connections featuring FIPS-compliant algorithms. **Roadmap**
+* LE Data Length Extension for higher throughput **Available now**
+* Enables users to assign an Internet Protocol (IP) address (complaint with the IPv6 or 6LoWPAN standard) to a Bluetooth device through Internet Protocol Support Profile (IPSP) **Roadmap**
+
+NimBLE supports features from older specifications including,
+
+* Support multiple roles (master(central)/slave(peripheral), server/client) simultaneously
+* Support simultaneous advertising and scanning
+* Support being slave to multiple masters simultaneously (subject to memory and scheduling constraints)
+* Low Duty Cycle Directed Advertising
+* Connection parameters request procedure
+* LE Ping
+* 32 bits UUID
+* L2CAP Connection Oriented Channels
+<br>
+
### Components
A Bluetooth low energy stack (NimBLE included) consists of two components with several subcomponents:* **Controller** * **Physical Layer**: adaptive frequency-hopping Gaussian Frequency Shift Keying (GFSK) radio using 40 RF channels (0-39), with 2 MHz spacing. * **Link Layer**: with one of five states (Standby, Advertising, Scanning, Initiating, Connection states) active at any time * **Host** * **Logical Link Control and Adaptation Protocol (L2CAP)**: provides logical channels, named L2CAP channels, which are multiplexed over one or more logical links to provide packet segmentation and reassembly, flow control, error control, streaming, QoS etc. * **Security Manager (SM)**: uses Security Manager Protocol (SMP) for pairing and transport specific key distribution for securing radio communication * **Attribute protocol (ATT)**: allows a device (*Server*) to expose certain pieces of data, known as *Attributes*, to another device (*Client*)
@@ -28,22 +40,9 @@ Subsequent chapters in this manual will go into the details of the implementatio
### Example NimBLE projects
-Mynewt comes with several built-in projects or applications using NimBLE. These allow users to try out NimBLE, understand how to use available services, and build their own applications using one or more of the examples as seed.
-
-1. **bletiny** : A simple shell application which provides a basic interface to the host-side of the BLE stack. Supported operations include GAP, GATT, and L2CAP.
+Mynewt comes with two built-in projects that allow users to play with NimBLE, try the tutorials out with, and see how to use available services.
+1. **bletiny** : A simple shell application which provides a basic interface to the host-side of the BLE stack.
2. **bleprph**: A basic peripheral device with no user interface. It advertises automatically on startup, and resumes advertising whenever a connection is terminated. It supports a maximum of one connection.
-3. **blecent**: A basic central device with no user interface. This application scans for a peripheral that supports the alert notification service (ANS). Upon discovering such a peripheral, blecent connects and performs the following actions:
-
- * Reads the ANS Supported New Alert Category characteristic.
- * Writes the ANS Alert Notification Control Point characteristic.
- * Subscribes to notifications for the ANS Unread Alert Status characteristic.
-
-
-4. **blehci**: Implements a BLE controller-only application. A separate host-only implementation, such as Linux's BlueZ, can interface with this application via HCI over UART.
-
-5. **bleuart**: Implements a simple BLE peripheral that supports the Nordic
-[UART / Serial Port Emulation service](https://developer.nordicsemi.com/nRF5_SDK/nRF51_SDK_v8.x.x/doc/8.0.0/s110/html/a00072.html)
-
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/newt/install/newt_linux.md
----------------------------------------------------------------------
diff --git a/docs/newt/install/newt_linux.md b/docs/newt/install/newt_linux.md
index 6a418ac..6f2509b 100644
--- a/docs/newt/install/newt_linux.md
+++ b/docs/newt/install/newt_linux.md
@@ -13,13 +13,11 @@ If you want to build the *newt* tool from its source code, follow the following
$ sudo apt-get install libcurl4-gnutls-dev
```
-**NOTE:** On 64-bit host, you may also need to install gcc-multilib, if you encounter compilation errors related to 'sys/cdefs.h'
-
<br>
#### 2. Install Go, the programming language
-* Go language environment dictates a directory structure. Known in Go parlance as a workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below.
+* Go language environment dictates a directory structure. Known in Go parlanace as workspace, it must contain three sibling directories with the directory names src, pkg and bin, as explained below.
* src contains Go source files organized into packages (one package per directory),
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/callout.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/callout.md b/docs/os/core_os/callout/callout.md
index ced9eb8..042dd7b 100644
--- a/docs/os/core_os/callout/callout.md
+++ b/docs/os/core_os/callout/callout.md
@@ -20,36 +20,34 @@ Callout timer fires out just once. For periodic timer type of operation you need
### Data structures
-```c
struct os_callout {
struct os_event c_ev;
struct os_eventq *c_evq;
uint32_t c_ticks;
TAILQ_ENTRY(os_callout) c_next;
};
-```
+
| Element | Description |
|---------|-------------|
-| `c_ev` | Event structure of this callout |
-| `c_evq` | Event queue where this callout is placed on timer expiry |
-| `c_ticks` | OS tick amount when timer fires |
-| `c_next` | Linkage to other unexpired callouts |
+| c_ev | Event structure of this callout |
+| c_evq | Event queue where this callout is placed on timer expiry |
+| c_ticks | OS tick amount when timer fires |
+| c_next | Linkage to other unexpired callouts |
+
-```c
struct os_callout_func {
struct os_callout cf_c;
os_callout_func_t cf_func;
void *cf_arg;
};
-```
| Element | Description |
|---------|-------------|
-| `cf_c` | struct os_callout. See above |
-| `cf_func` | Function pointer which should be called by event queue processing |
-| `cf_arg` | Generic void * argument to that function |
+| cf_c | struct os_callout. See above |
+| cf_func | Function pointer which should be called by event queue processing |
+| cf_arg | Generic void * argument to that function |
### List of Functions
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/os_callout_func_init.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/os_callout_func_init.md b/docs/os/core_os/callout/os_callout_func_init.md
index de62bef..2c45817 100644
--- a/docs/os/core_os/callout/os_callout_func_init.md
+++ b/docs/os/core_os/callout/os_callout_func_init.md
@@ -1,20 +1,20 @@
## <font color="#F2853F" style="font-size:24pt"> os_callout_func_init </font>
-```c
+
void os_callout_func_init(struct os_callout_func *cf, struct os_eventq *evq, os_callout_func_t timo_func, void *ev_arg)
-```
-Initializes the given `struct os_callout_func`. Data structure is filled in with elements given as argument.
+
+Initializes the given *struct os_callout_func*. Data structure is filled in with elements given as argument.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `cf` | Pointer to os_callout_func being initialized |
-| `evq` | Event queue where this gets delivered to |
-| `timo_func` | Timeout function. Event processing should call this |
-| `ev_arg` | Generic argument for the event |
+| cf | Pointer to os_callout_func being initialized |
+| evq | Event queue where this gets delivered to |
+| timo_func | Timeout function. Event processing should call this |
+| ev_arg | Generic argument for the event |
#### Returned values
@@ -22,13 +22,13 @@ N/A
#### Notes
-The same notes as with [`os_callout_init()`](os_callout_init.md).
+The same notes as with *os_callout_init()*.
#### Example
<Add text to set up the context for the example here>
-```c
+
struct os_callout_func g_native_cputimer;
struct os_eventq g_native_cputime_evq;
void native_cputimer_cb(void *arg);
@@ -38,7 +38,7 @@ The same notes as with [`os_callout_init()`](os_callout_init.md).
&g_native_cputime_evq,
native_cputimer_cb,
NULL);
-```
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/os_callout_init.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/os_callout_init.md b/docs/os/core_os/callout/os_callout_init.md
index e4896f6..7d30fdc 100644
--- a/docs/os/core_os/callout/os_callout_init.md
+++ b/docs/os/core_os/callout/os_callout_init.md
@@ -1,19 +1,19 @@
## <font color="#F2853F" style="font-size:24pt">os_callout_init </font>
-```c
+
void os_callout_init(struct os_callout *c, struct os_eventq *evq, void *ev_arg)
-```
-Initializes `struct os_callout`. Event type will be set to `OS_EVENT_T_TIMER`.
+
+Initializes *struct os_callout*. Event type will be set to *OS_EVENT_T_TIMER*.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `c` | Pointer to os_callout to initialize |
-| `evq` | Event queue where this gets delivered to |
-| `ev_arg` | Generic argument which is filled in for the event |
+| c | Pointer to os_callout to initialize |
+| evq | Event queue where this gets delivered to |
+| ev_arg | Generic argument which is filled in for the event |
#### Returned values
@@ -28,11 +28,11 @@ Or if the timer has already fired, it will mess up the event queue where the cal
<Add text to set up the context for the example here>
-```c
+
struct os_eventq my_evq;
struct os_callout my_callouts[8];
for (i = 0; i < 8; i++) {
os_callout_init(&my_callouts[i], &my_evq, (void *)i);
}
-```
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/os_callout_queued.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/os_callout_queued.md b/docs/os/core_os/callout/os_callout_queued.md
index 0917d13..9e69f96 100644
--- a/docs/os/core_os/callout/os_callout_queued.md
+++ b/docs/os/core_os/callout/os_callout_queued.md
@@ -1,8 +1,8 @@
## <font color="#F2853F" style="font-size:24pt">os_callout_queued</font>
-```c
+
int os_callout_queued(struct os_callout *c)
-```
+
Tells whether the callout has been armed or not.
@@ -11,12 +11,11 @@ Tells whether the callout has been armed or not.
| Arguments | Description |
|-----------|-------------|
-| `c` | Pointer to callout being checked |
+| c | Pointer to callout being checked |
#### Returned values
0: timer is not armed
-
non-zero: timer is armed
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/os_callout_reset.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/os_callout_reset.md b/docs/os/core_os/callout/os_callout_reset.md
index d9ff1d8..5c6875b 100644
--- a/docs/os/core_os/callout/os_callout_reset.md
+++ b/docs/os/core_os/callout/os_callout_reset.md
@@ -1,8 +1,8 @@
## <font color="#F2853F" style="font-size:24pt"> os_callout_reset </font>
-```c
+
void os_callout_reset(struct os_callout *c, int32_t timo)
-```
+
Resets the callout to happen *timo* in OS ticks.
@@ -11,8 +11,8 @@ Resets the callout to happen *timo* in OS ticks.
| Arguments | Description |
|-----------|-------------|
-| `c` | Pointer to os_callout being reset |
-| `timo` | OS ticks the timer is being set to |
+| c | Pointer to os_callout being reset |
+| timo | OS ticks the timer is being set to |
#### Returned values
@@ -27,7 +27,7 @@ N/A
<Add text to set up the context for the example here>
-```c
+
/* Re-start the timer (run every 50 msecs) */
os_callout_reset(&g_bletest_timer.cf_c, OS_TICKS_PER_SEC / 20);
-```
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/callout/os_callout_stop.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/callout/os_callout_stop.md b/docs/os/core_os/callout/os_callout_stop.md
index 45359b4..76aa87d 100644
--- a/docs/os/core_os/callout/os_callout_stop.md
+++ b/docs/os/core_os/callout/os_callout_stop.md
@@ -1,8 +1,8 @@
## <font color="#F2853F" style="font-size:24pt"> os_callout_stop </font>
-```c
+
void os_callout_stop(struct os_callout *c)
-```
+
Disarms a timer.
@@ -11,7 +11,7 @@ Disarms a timer.
| Arguments | Description |
|-----------|-------------|
-| `c` | Pointer to os_callout being stopped |
+| c | Pointer to os_callout being stopped |
#### Returned values
@@ -22,10 +22,10 @@ N/A
#### Example
-```c
+
struct os_callout_func g_native_cputimer;
os_callout_stop(&g_native_cputimer.cf_c);
-```
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/context_switch.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/context_switch.md b/docs/os/core_os/context_switch/context_switch.md
index e3c582a..b507149 100644
--- a/docs/os/core_os/context_switch/context_switch.md
+++ b/docs/os/core_os/context_switch/context_switch.md
@@ -7,19 +7,19 @@ Scheduler's job is to maintain the list of tasks and decide which one should be
Task states can be *running*, *ready to run* or *sleeping*.
-When a task is *running*, the CPU is executing in that task's context. The program counter (PC) is pointing to instructions that task wants to execute and the stack pointer (SP) is pointing to that task's stack.
+When task is *running*, CPU is executing in that task's context. The program counter (PC) is pointing to instructions task wants to execute and stack pointer (SP) is pointing to task's stack.
-A task which is *ready to run* wants to get on the CPU to do its work.
+Task which is *ready to run* wants to get on the CPU to do its work.
-A task which is *sleeping* has no more work to do. It's waiting for someone or something else to wake it up.
+Task which is *sleeping* has no more work to do. It's waiting for someone else to wake it up.
-The Scheduler algorithm is simple: from among the tasks which are ready to run, pick the the one with highest priority (lowest numeric value in task's `t_prio` field), and make its state *running*.
+Scheduler algorithm is simple: from among the tasks which are ready to run, pick the the one with highest priority (lowest numeric value in task's t_prio field), and make its state *running*.
-Tasks which are either *running* or *ready to run* are kept in a linked list `g_os_run_list`. This list is ordered by priority.
+Tasks which are either *running* or *ready to run* are kept in linked list `g_os_run_list`. This list is ordered by priority.
-Tasks which are *sleeping* are kept in a linked list `g_os_sleep_list`.
+Tasks which are *sleeping* are kept in linked list `g_os_sleep_list`.
-The scheduler has a CPU architecture specific component; this code is responsible for swapping in the task which should be *running*. This process is called context switch. During context switching the state of the CPU (e.g. registers) for the currently *running* task is stored and the new task is swapped in.
+Scheduler has a CPU architecture specific component; this code is responsible for swapping in the task which should be *running*. This process is called context switch. During context switching the state of the CPU (e.g. registers) for the currently *running* task is stored and the new task is swapped in.
## List of Functions
@@ -30,10 +30,10 @@ The functions available in context_switch are:
| **Function** | **Description** |
|-----------|-------------|
| [os_sched](os_sched.md) | Performs context switch if needed. |
-| [os_arch_ctx_sw](os_arch_ctx_sw.md) | Change the state of a given task to *running*. |
+| [os_arch_ctx_sw](os_arch_ctx_sw.md) | Change the state of task given task to *running*. |
| [os_sched_ctx_sw_hook](os_sched_ctx_sw_hook.md) | Performs task accounting when context switching. |
-| [os_sched_get_current_task](os_sched_get_current_task.md) | Returns the pointer to the task which is currently *running*. |
-| [os_sched_insert](os_sched_insert.md) | Insert a task into scheduler's *ready to run* list. |
+| [os_sched_get_current_task](os_sched_get_current_task.md) | Returns the pointer to task which is currently *running*. |
+| [os_sched_insert](os_sched_insert.md) | Insert task into scheduler's ready to run list. |
| [os_sched_next_task](os_sched_next_task.md) | Returns the pointer to highest priority task from the list which are *ready to run*. |
| [os_sched_os_timer_exp](os_sched_os_timer_exp.md) | Inform scheduler that OS time has moved forward. |
| [os_sched_resort](os_sched_resort.md) | Inform scheduler that the priority of the given task has changed and the *ready to run* list should be re-sorted. |
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_arch_ctx_sw.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_arch_ctx_sw.md b/docs/os/core_os/context_switch/os_arch_ctx_sw.md
index 9c59b28..2a1c7f7 100644
--- a/docs/os/core_os/context_switch/os_arch_ctx_sw.md
+++ b/docs/os/core_os/context_switch/os_arch_ctx_sw.md
@@ -1,16 +1,16 @@
-##<font color="#F2853F" style="font-size:24pt"> os_arch_ctx_sw </font>
+## <font color="#F2853F" style="font-size:24pt"> os_arch_ctx_sw </font>
+
-```c
void os_arch_ctx_sw(struct os_task *next_t)
-```
-Change the state of task pointed by `next_t` to be *running*.
+
+Change the state of task pointed by *next_t* to be *running*.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `next_t` | Pointer to task which must run next |
+| next_t | Pointer to task which must run next |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched.md b/docs/os/core_os/context_switch/os_sched.md
index 4cbeefc..2eb34cf 100644
--- a/docs/os/core_os/context_switch/os_sched.md
+++ b/docs/os/core_os/context_switch/os_sched.md
@@ -1,10 +1,10 @@
-##<font color="#F2853F" style="font-size:24pt"> os_sched </font>
+## <font color="#F2853F" style="font-size:24pt"> os_sched </font>
```c
void os_sched(struct os_task *next_t)
```
-Performs context switch if needed. If `next_t` is set, that task will be made *running*. If `next_t` is **NULL**, highest priority *ready to run* is swapped in. This function can be called when new tasks were made *ready to run* or if the current task is moved to *sleeping* state.
+Performs context switch if needed. If *next_t* is set, that task will be made *running*. If *next_t* is NULL, highest priority *ready to run* is swapped in. This function can be called when new tasks were made *ready to run* or if the current task is moved to *sleeping* state.
This function will call the architecture specific routine to swap in the new task.
@@ -12,7 +12,7 @@ This function will call the architecture specific routine to swap in the new tas
| Arguments | Description |
|-----------|-------------|
-| `next_t` | Pointer to task which must run next (optional) |
+| next_t | Pointer to task which must run next (optional) |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_ctx_sw_hook.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_ctx_sw_hook.md b/docs/os/core_os/context_switch/os_sched_ctx_sw_hook.md
index dd586fd..3042478 100644
--- a/docs/os/core_os/context_switch/os_sched_ctx_sw_hook.md
+++ b/docs/os/core_os/context_switch/os_sched_ctx_sw_hook.md
@@ -6,7 +6,7 @@ void os_sched_ctx_sw_hook(struct os_task *next_t)
Performs task accounting when context switching.
-This function must be called from the architecture specific context switching routine `os_arch_ctx_sw()` before resuming execution of the *running* task.
+This function must be called from the architecture specific context switching routine *os_arch_ctx_sw()* before resuming execution of the *running* task.
#### Arguments
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_insert.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_insert.md b/docs/os/core_os/context_switch/os_sched_insert.md
index 46fcb52..dce6755 100644
--- a/docs/os/core_os/context_switch/os_sched_insert.md
+++ b/docs/os/core_os/context_switch/os_sched_insert.md
@@ -1,7 +1,8 @@
## <font color="#F2853F" style="font-size:24pt"> os_sched_insert </font>
```c
-os_error_t os_sched_insert(struct os_task *t)
+os_error_t
+os_sched_insert(struct os_task *t)
```
Insert task into scheduler's *ready to run* list.
@@ -11,11 +12,11 @@ Insert task into scheduler's *ready to run* list.
| Arguments | Description |
|-----------|-------------|
-| `t`| Pointer to task |
+| t | Pointer to task |
#### Returned values
-Returns `OS_EINVAL` if task state is not **READY**.
+Returns OS_EINVAL if task state is not *READY*.
Returns 0 on success.
#### Notes
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_os_timer_exp.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_os_timer_exp.md b/docs/os/core_os/context_switch/os_sched_os_timer_exp.md
index 3d2c5ca..f5a03fc 100644
--- a/docs/os/core_os/context_switch/os_sched_os_timer_exp.md
+++ b/docs/os/core_os/context_switch/os_sched_os_timer_exp.md
@@ -4,9 +4,9 @@
void os_sched_os_timer_exp(void)
```
-Inform scheduler that OS time has moved forward, and it should inspect tasks which are *sleeping* to check whether they should be moved to `g_run_list` or not.
+Inform scheduler that OS time has moved forward, and it should inspect tasks which are *sleeping* to check whether they should be moved to *g_run_list* or not.
-This function should be called from code which handles moving OS time forward. After calling it, the highest priority task which is *ready to run* might've changed, so call to `os_sched()` should be done.
+This function should be called from code which handles moving OS time forward. After calling it, the highest priority task which is *ready to run* might've changed, so call to *os_sched()* should be done.
#### Arguments
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_resort.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_resort.md b/docs/os/core_os/context_switch/os_sched_resort.md
index 5109a88..c755fb3 100644
--- a/docs/os/core_os/context_switch/os_sched_resort.md
+++ b/docs/os/core_os/context_switch/os_sched_resort.md
@@ -4,13 +4,13 @@
void os_sched_resort(struct os_task *t)
```
-Inform scheduler that the priority of the task `t` has changed (e.g. in order to avoid priority inversion), and the *ready to run* list should be re-sorted.
+Inform scheduler that the priority of the task *t* has changed (e.g. in order to avoid priority inversion), and the *ready to run* list should be re-sorted.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `t` | Pointer to a task whose priority has changed |
+| t | Pointer to a task whose priority has changed |
#### Returned values
@@ -18,7 +18,7 @@ N/A
#### Notes
-`t` must be *ready to run* before calling this.
+*t* must be *ready to run* before calling this.
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_set_current_task.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_set_current_task.md b/docs/os/core_os/context_switch/os_sched_set_current_task.md
index 8604e1a..8839980 100644
--- a/docs/os/core_os/context_switch/os_sched_set_current_task.md
+++ b/docs/os/core_os/context_switch/os_sched_set_current_task.md
@@ -5,15 +5,15 @@ void
os_sched_set_current_task(struct os_task *t)
```
-Sets the currently running task to `t`.
+Sets the currently running task to 't'.
-This is called from architecture specific context switching code to update scheduler state. Call is made when state of the task `t` is made *running*.
+This is called from architecture specific context switching code to update scheduler state. Call is made when state of the task 't' is made *running*.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `t` | Pointer to a task |
+| t | Pointer to a task |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_sleep.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_sleep.md b/docs/os/core_os/context_switch/os_sched_sleep.md
index 1ea45aa..3c46887 100644
--- a/docs/os/core_os/context_switch/os_sched_sleep.md
+++ b/docs/os/core_os/context_switch/os_sched_sleep.md
@@ -5,18 +5,18 @@ int
os_sched_sleep(struct os_task *t, os_time_t nticks)
```
-Task `t` state is changed from *ready to run* to *sleeping*. Sleep time will be specified in `nticks`.
+Task 't' state is changed from *ready to run* to *sleeping*. Sleep time will be specified in *nticks*.
-Task will be woken up after sleep timer expires, unless there are other signals causing it to wake up.
+Task will be woken up after sleep timer expires, unless there are other signals causing it to wake up.
-If `nticks` is set to `OS_TIMEOUT_NEVER`, task never wakes up with a sleep timer.
+If *nticks* is set to *OS_TIMEOUT_NEVER*, task never wakes up with a sleep timer.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `t` | Pointer to task |
-| `nticks` | Number of ticks to sleep in OS ticks |
+| t | Pointer to task |
+| nticks | Number of ticks to sleep in OS ticks |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/context_switch/os_sched_wakeup.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/context_switch/os_sched_wakeup.md b/docs/os/core_os/context_switch/os_sched_wakeup.md
index cb884be..4407c96 100644
--- a/docs/os/core_os/context_switch/os_sched_wakeup.md
+++ b/docs/os/core_os/context_switch/os_sched_wakeup.md
@@ -12,7 +12,7 @@ Called to make task *ready to run*. If task is *sleeping*, it is woken up.
| Arguments | Description |
|-----------|-------------|
-| `t` | Pointer to task |
+| t | Pointer to task |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/event_queue/event_queue.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/event_queue/event_queue.md b/docs/os/core_os/event_queue/event_queue.md
index 748673e..7f3d36d 100644
--- a/docs/os/core_os/event_queue/event_queue.md
+++ b/docs/os/core_os/event_queue/event_queue.md
@@ -3,23 +3,23 @@
Event queue is a way of serializing events arring to a task. This makes it easy to queue processing to happen inside task's context. This would be done either from an interrupt handler, or from another task.
-Events arrive in a form of a data structure `struct os_event`.
+Events arrive in a form of a data structure *struct os_event*.
### Description
-Events are in form of a data structure `struct os_event`, and they are queued to data structure `struct os_eventq`.
+Events are in form of a data structure *struct os_event*, and they are queued to data structure *struct os_eventq*.
-Queue must be initialized before trying to add events to it. This is done using `os_eventq_init()`.
+Queue must be initialized before trying to add events to it. This is done using *os_eventq_init()*.
-Common way of using event queues is to have a task loop while calling `os_eventq_get()`, waiting for work to do.
-Other tasks (or interrupts) then call `os_eventq_put()` to wake it up. Once event has been queued task waiting on that queue is woken up, and will get a pointer to queued event structure.
+Common way of using event queues is to have a task loop while calling *os_eventq_get()*, waiting for work to do.
+Other tasks (or interrupts) then call *os_eventq_put()* to wake it up. Once event has been queued task waiting on that queue is woken up, and will get a pointer to queued event structure.
Processing task would then act according to event type.
-When `os_event` is queued, it should not be freed until processing task is done with it.
+When *os_event* is queued, it should not be freed until processing task is done with it.
-It is assumed that there is only one task consuming events from an event queue. Only one task should be sleeping on a particular `os_eventq` at a time.
+It is assumed that there is only one task consuming events from an event queue. Only one task should be sleeping on a particular *os_eventq* at a time.
-Note that [os_callout](../callout/callout.md) subsystem assumes that event queue is used as the wakeup mechanism.
+Note that os_callout subsystem assumes that event queue is used as the wakeup mechanism.
### Data structures
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/event_queue/os_eventq_get.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/event_queue/os_eventq_get.md b/docs/os/core_os/event_queue/os_eventq_get.md
index 9bff17c..6cfe242 100644
--- a/docs/os/core_os/event_queue/os_eventq_get.md
+++ b/docs/os/core_os/event_queue/os_eventq_get.md
@@ -12,12 +12,12 @@ Fetches the first event from a queue. Task will sleep until something gets queue
| Arguments | Description |
|-----------|-------------|
-| `evq` | Queue to wait on |
+| evq | Queue to wait on |
#### Returned values
-Will return with a pointer to first `struct event` which is in the queue.
+Will return with a pointer to first *struct event* which is in the queue.
#### Notes
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/event_queue/os_eventq_init.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/event_queue/os_eventq_init.md b/docs/os/core_os/event_queue/os_eventq_init.md
index 0c712bd..5251a89 100644
--- a/docs/os/core_os/event_queue/os_eventq_init.md
+++ b/docs/os/core_os/event_queue/os_eventq_init.md
@@ -5,13 +5,13 @@
os_eventq_init(struct os_eventq *evq)
```
-Initializes `struct os_eventq`, making it ready for use.
+Initializes *struct os_eventq*, making it ready for use.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `evq` | Pointer to event queue getting initialized |
+| evq | Pointer to event queue getting initialized |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/event_queue/os_eventq_put.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/event_queue/os_eventq_put.md b/docs/os/core_os/event_queue/os_eventq_put.md
index d46197c..9bf3543 100644
--- a/docs/os/core_os/event_queue/os_eventq_put.md
+++ b/docs/os/core_os/event_queue/os_eventq_put.md
@@ -5,15 +5,15 @@ void
os_eventq_put(struct os_eventq *evq, struct os_event *ev)
```
-Queues an event to the tail of the event queue.
+Queues an event to tail of the event queue.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `evq` | Queue where event is being placed |
-| `ev` | Event which is being queued |
+| evq | Queue where event is being placed |
+| ev | Event which is being queued |
#### Returned values
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/event_queue/os_eventq_remove.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/event_queue/os_eventq_remove.md b/docs/os/core_os/event_queue/os_eventq_remove.md
index 7adcd36..88cd7c5 100644
--- a/docs/os/core_os/event_queue/os_eventq_remove.md
+++ b/docs/os/core_os/event_queue/os_eventq_remove.md
@@ -12,8 +12,8 @@ Removes an event which has been placed in a queue.
| Arguments | Description |
|-----------|-------------|
-| `evq` | Queue where event is being removed from |
-| `ev` | Event which is being removed |
+| evq | Queue where event is being removed from |
+| ev | Event which is being removed |
#### Returned values
@@ -26,7 +26,7 @@ N/A
#### Example
<Add text to set up the context for the example here>
-This is from `os_callout_stop()`. User wants to stop a callout from getting passed to a task. If the event has already been queued, then remove it before it is seen.
+This is from os_callout_stop(). User wants to stop a callout from getting passed to a task. If the event has already been queued, then remove it before it is seen.
```c
if (c->c_evq) {
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/heap/heap.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/heap/heap.md b/docs/os/core_os/heap/heap.md
index efdd5f6..1981a4f 100644
--- a/docs/os/core_os/heap/heap.md
+++ b/docs/os/core_os/heap/heap.md
@@ -6,7 +6,7 @@ API for doing dynamic memory allocation.
### Description
-This provides `malloc()` & `free()` functionality with locking. The shared resource heap needs to be protected from concurrent access when OS has been started. `os_malloc()` function grabs a mutex before calling `malloc()`.
+This provides malloc()/free() functionality with locking. The shared resource heap needs to be protected from concurrent access when OS has been started. *os_malloc()* function grabs a mutex before calling *malloc()*.
### Data structures
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/heap/os_free.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/heap/os_free.md b/docs/os/core_os/heap/os_free.md
index 9a22ec2..feb4946 100644
--- a/docs/os/core_os/heap/os_free.md
+++ b/docs/os/core_os/heap/os_free.md
@@ -11,7 +11,7 @@ Frees previously allocated memory back to the heap.
| Arguments | Description |
|-----------|-------------|
-| `mem` | Pointer to memory being released |
+| mem | Pointer to memory being released |
#### Returned values
@@ -19,7 +19,7 @@ N/A
#### Notes
-Calls C-library `free()` under the covers.
+Calls C-library *free()* behind the covers.
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/heap/os_malloc.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/heap/os_malloc.md b/docs/os/core_os/heap/os_malloc.md
index 65220a3..ab6544b 100644
--- a/docs/os/core_os/heap/os_malloc.md
+++ b/docs/os/core_os/heap/os_malloc.md
@@ -4,24 +4,24 @@
void *os_malloc(size_t size)
```
-Allocates `size` number of bytes from heap and returns a pointer to it.
+Allocates *size* number of bytes from heap and returns a pointer to it.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `size` | Number of bytes to allocate |
+| size | Number of bytes to allocate |
#### Returned values
-`<ptr>`: pointer to memory allocated from heap.
-**NULL**: not enough memory available.
+<ptr>: pointer to memory allocated from heap.
+NULL: not enough memory available.
#### Notes
-`os_malloc()` calls `malloc()`, which is provided by the C-library. The heap must be set up during platform initialization.
-Depending on which C-library you use, you might have to do the heap setup differently. Most often `malloc()` implementation will maintain a list of allocated and then freed memory blocks. If user asks for memory which cannot be satisfied from free list, they'll call platform's `sbrk()`, which then tries to grow the heap.
+*os_malloc()* calls *malloc()*, which is provided by C-library. The heap must be set up during platform initialization.
+Depending on which C-library you use, you might have to do the heap setup differently. Most often *malloc()* implementation will maintain a list of allocated and then freed memory blocks. If user asks for memory which cannot be satisfied from free list, they'll call platform's *sbrk()*, which then tries to grow the heap.
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/heap/os_realloc.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/heap/os_realloc.md b/docs/os/core_os/heap/os_realloc.md
index 7e2e08e..e675155 100644
--- a/docs/os/core_os/heap/os_realloc.md
+++ b/docs/os/core_os/heap/os_realloc.md
@@ -5,19 +5,19 @@ void *os_realloc(void *ptr, size_t size)
```
Tries to resize previously allocated memory block, and returns pointer to resized memory.
-`ptr` can be **NULL**, in which case the call is similar to calling `os_malloc()`.
+ptr can be NULL, in which case the call is similar to calling *os_malloc()*.
#### Arguments
| Arguments | Description |
|-----------|-------------|
-| `ptr` | Pointer to previously allocated memory |
-| `size` | New size to adjust the memory block to |
+| ptr | Pointer to previously allocated memory |
+| size | New size to adjust the memory block to |
#### Returned values
-**NULL**: size adjustment was not successful. <br>
-`ptr`: pointer to new start of memory block
+NULL: size adjustment was not successful. <br>
+ptr: pointer to new start of memory block
#### Notes
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_DATA.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_DATA.md b/docs/os/core_os/mbuf/OS_MBUF_DATA.md
index bce48af..27effcb 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_DATA.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_DATA.md
@@ -14,8 +14,8 @@ Macro used to cast the data pointer of an mbuf to a given type.
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *) |
-| `__type` | Type to cast |
+| __om | Pointer to mbuf (struct os_mbuf *) |
+| __type | Type to cast |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md b/docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md
index ecbbb1f..a132362 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_LEADINGSPACE.md
@@ -14,13 +14,13 @@ Macro used to get the amount of leading space in an mbuf (in bytes).
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *) |
+| __om | Pointer to mbuf (struct os_mbuf *) |
<br>
#### Notes
-This macro works on both normal mbufs and packet header mbufs. The amount of leading space is the number of bytes between the current `om_data` pointer of the mbuf and the start of the mbuf user data buffer.
+This macro works on both normal mbufs and packet header mbufs. The amount of leading space is the number of bytes between the current om_data pointer of the mbuf and the start of the mbuf user data buffer.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md b/docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md
index c867b16..98faaec 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_PKTHDR.md
@@ -14,7 +14,7 @@ Macro used to get a pointer to the os mbuf packet header of an mbuf.
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *) |
+| __om | Pointer to mbuf (struct os_mbuf *) |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md b/docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md
index 0a9dbf8..942dcd2 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_PKTHDR_TO_MBUF.md
@@ -12,7 +12,7 @@ Macro used to get a pointer to the mbuf given a pointer to the os mbuf packet he
| Arguments | Description |
|-----------|-------------|
-| `__hdr` | Pointer to os mbuf packet header (struct os_mbuf_pkthdr *) |
+| __hdr | Pointer to os mbuf packet header (struct os_mbuf_pkthdr *) |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md b/docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md
index fdab0b5..104cca3 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_PKTLEN.md
@@ -14,7 +14,7 @@ Macro used to get the length of an entire mbuf chain.
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *) |
+| __om | Pointer to mbuf (struct os_mbuf *) |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md b/docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md
index 40a1825..d93d948 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_TRAILINGSPACE.md
@@ -14,13 +14,13 @@ Macro used to get the amount of trailing space in an mbuf (in bytes).
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *) |
+| __om | Pointer to mbuf (struct os_mbuf *) |
<br>
#### Notes
-This macro works on both normal mbufs and packet header mbufs. The amount of trailing space is the number of bytes between the current `om_data` pointer of the mbuf and the end of the mbuf.
+This macro works on both normal mbufs and packet header mbufs. The amount of trailing space is the number of bytes between the current om_data pointer of the mbuf and the end of the mbuf.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_USRHDR.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_USRHDR.md b/docs/os/core_os/mbuf/OS_MBUF_USRHDR.md
index 024f86e..e54cbb7 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_USRHDR.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_USRHDR.md
@@ -13,7 +13,7 @@ Macro used to get a pointer to the user packet header of an mbuf.
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *). Must be head of chain (i.e. a packet header mbuf) |
+| __om | Pointer to mbuf (struct os_mbuf *). Must be head of chain (i.e. a packet header mbuf) |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md b/docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md
index 529d163..ebc8611 100644
--- a/docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md
+++ b/docs/os/core_os/mbuf/OS_MBUF_USRHDR_LEN.md
@@ -13,7 +13,7 @@ Macro used to retrieve the length of the user packet header in an mbuf.
| Arguments | Description |
|-----------|-------------|
-| `__om` | Pointer to mbuf (struct os_mbuf *). Must be head of chain (i.e. a packet header mbuf) |
+| __om | Pointer to mbuf (struct os_mbuf *). Must be head of chain (i.e. a packet header mbuf) |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/mbuf.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/mbuf.md b/docs/os/core_os/mbuf/mbuf.md
index 01b6a8c..4f14818 100644
--- a/docs/os/core_os/mbuf/mbuf.md
+++ b/docs/os/core_os/mbuf/mbuf.md
@@ -10,7 +10,7 @@ The main reason is to conserve memory. Consider a networking protocol that gener
### Packet Header mbuf
-Not all mbufs are created equal. The first mbuf in a chain of mbufs is a special mbuf called a "packet header mbuf". The reason that this mbuf is special is that it contains the length of all the data contained by the chain of mbufs (the packet length, in other words). The packet header mbuf may also contain a user defined structure (called a "user header") so that networking protocol specific information can be conveyed to various layers of the networking stack. Any mbufs that are part of the packet (i.e. in the mbuf chain but not the first one) are "normal" (i.e. non-packet header) mbufs. A normal mbuf does not have any packet header or user packet header structures in them; they only contain the basic mbuf header (`struct os_mbuf`). Figure 1 illustrates these two types of mbufs. Note that the numbers/text in parentheses denote the size of the structures/elements (in bytes) and that `MBLEN` is the memory block length of the memory pool used by the mbuf pool.
+Not all mbufs are created equal. The first mbuf in a chain of mbufs is a special mbuf called a "packet header mbuf". The reason that this mbuf is special is that it contains the length of all the data contained by the chain of mbufs (the packet length, in other words). The packet header mbuf may also contain a user defined structure (called a "user header") so that networking protocol specific information can be conveyed to various layers of the networking stack. Any mbufs that are part of the packet (i.e. in the mbuf chain but not the first one) are "normal" (i.e. non-packet header) mbufs. A normal mbuf does not have any packet header or user packet header structures in them; they only contain the basic mbuf header (`struct os_mbuf`). Figure 1 illustrates these two types of mbufs. Note that the numbers/text in parentheses denote the size of the structures/elements (in bytes) and that MBLEN is the memory block length of the memory pool used by the mbuf pool.
@@ -18,28 +18,28 @@ Not all mbufs are created equal. The first mbuf in a chain of mbufs is a special
Now let's take a deeper dive into the mbuf structure. Figure 2 illustrates a normal mbuf and breaks out the various fields in the `os_mbuf` structure.
-* The `om_data` field is a pointer to where the data starts inside the data buffer. Typically, mbufs that are allocated from the mbuf pool (discussed later) have their `om_data` pointer set to the start of the data buffer but there are cases where this may not be desirable (added a protocol header to a packet, for example).
-* The `om_flags` field is a set of flags used internally by the mbuf library. Currently, no flags have been defined.
-* The `om_pkthdr_len` field is the total length of all packet headers in the mbuf. For normal mbufs this is set to 0 as there is no packet or user packet headers. For packet header mbufs, this would be set to the length of the packet header structure (16) plus the size of the user packet header (if any). Note that it is this field which differentiates packet header mbufs from normal mbufs (i.e. if `om_pkthdr_len` is zero, this is a normal mbuf; otherwise it is a packet header mbuf).
-* The `om_len` field contains the amount of user data in the data buffer. When initially allocated, this field is 0 as there is no user data in the mbuf.
-* The `omp_pool` field is a pointer to the pool from which this mbuf has been allocated. This is used internally by the mbuf library.
-* The `omp_next` field is a linked list element which is used to chain mbufs.
+* The *om_data* field is a pointer to where the data starts inside the data buffer. Typically, mbufs that are allocated from the mbuf pool (discussed later) have their om_data pointer set to the start of the data buffer but there are cases where this may not be desirable (added a protocol header to a packet, for example).
+* The *om_flags* field is a set of flags used internally by the mbuf library. Currently, no flags have been defined.
+* The *om_pkthdr_len* field is the total length of all packet headers in the mbuf. For normal mbufs this is set to 0 as there is no packet or user packet headers. For packet header mbufs, this would be set to the length of the packet header structure (16) plus the size of the user packet header (if any). Note that it is this field which differentiates packet header mbufs from normal mbufs (i.e. if *om_pkthdr_len* is zero, this is a normal mbuf; otherwise it is a packet header mbuf).
+* The *om_len* field contains the amount of user data in the data buffer. When initially allocated, this field is 0 as there is no user data in the mbuf.
+* The *omp_pool* field is a pointer to the pool from which this mbuf has been allocated. This is used internally by the mbuf library.
+* The *omp_next* field is a linked list element which is used to chain mbufs.
-Figure 2 also shows a normal mbuf with actual values in the `os_mbuf` structure. This mbuf starts at address 0x1000 and is 256 bytes in total length. In this example, the user has copied 33 bytes into the data buffer starting at address 0x1010 (this is where `om_data` points). Note that the packet header length in this mbuf is 0 as it is not a packet header mbuf.
+Figure 2 also shows a normal mbuf with actual values in the `os_mbuf` structure. This mbuf starts at address 0x1000 and is 256 bytes in total length. In this example, the user has copied 33 bytes into the data buffer starting at address 0x1010 (this is where om_data points). Note that the packet header length in this mbuf is 0 as it is not a packet header mbuf.
-Figure 3 illustrates the packet header mbuf along with some chained mbufs (i.e a "packet"). In this example, the user header structure is defined to be 8 bytes. Note that in figure 3 we show a number of different mbufs with varying `om_data` pointers and lengths since we want to show various examples of valid mbufs. For all the mbufs (both packet header and normal ones) the total length of the memory block is 128 bytes.
+Figure 3 illustrates the packet header mbuf along with some chained mbufs (i.e a "packet"). In this example, the user header structure is defined to be 8 bytes. Note that in figure 3 we show a number of different mbufs with varying *om_data* pointers and lengths since we want to show various examples of valid mbufs. For all the mbufs (both packet header and normal ones) the total length of the memory block is 128 bytes.
### Mbuf pools
-Mbufs are collected into "mbuf pools" much like memory blocks. The mbuf pool itself contains a pointer to a memory pool. The memory blocks in this memory pool are the actual mbufs; both normal and packet header mbufs. Thus, the memory block (and corresponding memory pool) must be sized correctly. In other words, the memory blocks which make up the memory pool used by the mbuf pool must be at least: `sizeof(struct os_mbuf)` + `sizeof(struct os_mbuf_pkthdr)` + `sizeof(struct user_defined_header)` + *desired minimum data buffer length*. For example, if the developer wants mbufs to contain at least 64 bytes of user data and they have a user header of 12 bytes, the size of the memory block would be (at least): 64 + 12 + 16 + 8, or 100 bytes. Yes, this is a fair amount of overhead. However, the flexibility provided by the mbuf library usually outweighs overhead concerns.
+Mbufs are collected into "mbuf pools" much like memory blocks. The mbuf pool itself contains a pointer to a memory pool. The memory blocks in this memory pool are the actual mbufs; both normal and packet header mbufs. Thus, the memory block (and corresponding memory pool) must be sized correctly. In other words, the memory blocks which make up the memory pool used by the mbuf pool must be at least: sizeof(struct os_mbuf) + sizeof(struct os_mbuf_pkthdr) + sizeof(struct user_defined_header) + desired minimum data buffer length. For example, if the developer wants mbufs to contain at least 64 bytes of user data and they have a user header of 12 bytes, the size of the memory block would be (at least): 64 + 12 + 16 + 8, or 100 bytes. Yes, this is a fair amount of overhead. However, the flexibility provided by the mbuf library usually outweighs overhead concerns.
### Create mbuf pool
-Creating an mbuf pool is fairly simple: create a memory pool and then create the mbuf pool using that memory pool. Once the developer has determined the size of the user data needed per mbuf (this is based on the application/networking stack and is outside the scope of this discussion) and the size of the user header (if any), the memory blocks can be sized. In the example shown below, the application requires 64 bytes of user data per mbuf and also allocates a user header (called `struct user_hdr`). Note that we do not show the user header data structure as there really is no need; all we need to do is to account for it when creating the memory pool. In the example, we use the macro `MBUF_PKTHDR_OVERHEAD` to denote the amount of packet header overhead per mbuf and `MBUF_MEMBLOCK_OVERHEAD` to denote the total amount of overhead required per memory block. The macro `MBUF_BUF_SIZE` is used to denote the amount of payload that the application requires (aligned on a 32-bit boundary in t
his case). All this leads to the total memory block size required, denoted by the macro `MBUF_MEMBLOCK_OVERHEAD`.
+Creating an mbuf pool is fairly simple: create a memory pool and then create the mbuf pool using that memory pool. Once the developer has determined the size of the user data needed per mbuf (this is based on the application/networking stack and is outside the scope of this discussion) and the size of the user header (if any), the memory blocks can be sized. In the example shown below, the application requires 64 bytes of user data per mbuf and also allocates a user header (called struct user_hdr). Note that we do not show the user header data structure as there really is no need; all we need to do is to account for it when creating the memory pool. In the example, we use the macro *MBUF_PKTHDR_OVERHEAD* to denote the amount of packet header overhead per mbuf and *MBUF_MEMBLOCK_OVERHEAD* to denote the total amount of overhead required per memory block. The macro *MBUF_BUF_SIZE* is used to denote the amount of payload that the application requires (aligned on a 32-bit boundary in thi
s case). All this leads to the total memory block size required, denoted by the macro *MBUF_MEMBLOCK_OVERHEAD*.
```c
@@ -106,9 +106,9 @@ mbuf_usage_example1(uint8_t *mydata, int mydata_length)
}
```
-In `example2` we show use of the pullup api as this illustrates some of the typical pitfalls developers encounter when using mbufs. The first pitfall is one of alignment/padding. Depending on the processor and/or compiler, the `sizeof()` a structure may vary. Thus, the size of `my_protocol_header` may be different inside the packet data of the mbuf than the size of the structure on the stack or as a global variable, for instance. While some networking protcols may align protocol information on convenient processor boundaries many others try to conserve bytes "on the air" (i.e inside the packet data). Typical methods used to deal with this are "packing" the structure (i.e. force compiler to not pad) or creating protocol headers that do not require padding. `example2` assumes that one of these methods was used when defining the `my_protocol_header` structure.
+In `example2` we show use of the pullup api as this illustrates some of the typical pitfalls developers encounter when using mbufs. The first pitfall is one of alignment/padding. Depending on the processor and/or compiler, the sizeof() a structure may vary. Thus, the size of *my_protocol_header* may be different inside the packet data of the mbuf than the size of the structure on the stack or as a global variable, for instance. While some networking protcols may align protocol information on convenient processor boundaries many others try to conserve bytes "on the air" (i.e inside the packet data). Typical methods used to deal with this are "packing" the structure (i.e. force compiler to not pad) or creating protocol headers that do not require padding. `example2` assumes that one of these methods was used when defining the *my_protocol_header* structure.
-Another common pitfall occurs around endianness. A network protocol may be little endian or big endian; it all depends on the protocol specification. Processors also have an endianness; this means that the developer has to be careful that the processor endianness and the protocol endianness are handled correctly. In `example2`, some common networking functions are used: `ntohs()` and `ntohl()`. These are shorthand for "network order to host order, short" and "network order to host order, long". Basically, these functions convert data of a certain size (i.e. 16 bits, 32 bits, etc) to the endianness of the host. Network byte order is big-endian (most significant byte first), so these functions convert big-endian byte order to host order (thus, the implementation of these functions is host dependent). Note that the BLE networking stack "on the air" format is least signigicant byte first (i.e. little-endian), so a `bletoh` function would have to take little-endian format and convert to
host format.
+Another common pitfall occurs around endianness. A network protocol may be little endian or big endian; it all depends on the protocol specification. Processors also have an endianness; this means that the developer has to be careful that the processor endianness and the protocol endianness are handled correctly. In `example2`, some common networking functions are used: `ntohs()` and `ntohl()`. These are shorthand for "network order to host order, short" and "network order to host order, long". Basically, these functions convert data of a certain size (i.e. 16 bits, 32 bits, etc) to the endianness of the host. Network byte order is big-endian (most significant byte first), so these functions convert big-endian byte order to host order (thus, the implementation of these functions is host dependent). Note that the BLE networking stack "on the air" format is least signigicant byte first (i.e. little endian), so a "bletoh" function would have to take little endian format and convert to
host format.
A long story short: the developer must take care when copying structure data to/from mbufs and flat buffers!
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_adj.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_adj.md b/docs/os/core_os/mbuf/os_mbuf_adj.md
index c89a4a8..a3881b4 100644
--- a/docs/os/core_os/mbuf/os_mbuf_adj.md
+++ b/docs/os/core_os/mbuf/os_mbuf_adj.md
@@ -4,7 +4,7 @@
void os_mbuf_adj(struct os_mbuf *mp, int req_len);
```
-Trims `req_len` bytes from either the head (if positive) or tail (if negative) of an mbuf chain. Adjusts the packet length of the mbuf chain if `mp` points to a packet header mbuf. When trimming from the head, no mbufs are freed. When trimming from the tail, any mbufs of zero length left at the end of the chain are freed.
+Trims *req_len* bytes from either the head (if positive) or tail (if negative) of an mbuf chain. Adjusts the packet length of the mbuf chain if *mp* points to a packet header mbuf. When trimming from the head, no mbufs are freed. When trimming from the tail, any mbufs of zero length left at the end of the chain are freed.
<br>
@@ -12,8 +12,8 @@ Trims `req_len` bytes from either the head (if positive) or tail (if negative) o
| Arguments | Description |
|-----------|-------------|
-| `mp` | Pointer to mbuf. Can be head of a chain of mbufs, a single mbuf or a packet header mbuf |
-| `req_len` | Number of bytes to trim from head or tail of mbuf
+| mp | Pointer to mbuf. Can be head of a chain of mbufs, a single mbuf or a packet header mbuf |
+| req_len | Number of bytes to trim from head or tail of mbuf
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_append.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_append.md b/docs/os/core_os/mbuf/os_mbuf_append.md
index 8d66e18..423409f 100644
--- a/docs/os/core_os/mbuf/os_mbuf_append.md
+++ b/docs/os/core_os/mbuf/os_mbuf_append.md
@@ -4,7 +4,7 @@
int os_mbuf_append(struct os_mbuf *om, const void *data, uint16_t len)
```
-Appends a data buffer of length `len` to the end of an mbuf chain, adjusting packet length if `om` is a packet header mbuf. If not enough trailing space exists at the end of the mbuf chain, mbufs are allocated to hold the data.
+Appends a data buffer of length *len* to the end of an mbuf chain, adjusting packet length if *om* is a packet header mbuf. If not enough trailing space exists at the end of the mbuf chain, mbufs are allocated to hold the data.
<br>
@@ -12,9 +12,9 @@ Appends a data buffer of length `len` to the end of an mbuf chain, adjusting pac
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf. Can be head of a chain of mbufs, a single mbuf or a packet header mbuf |
-| `data` | Pointer to data buffer to copy from |
-| `len` | Number of bytes to copy from data buffer to the end of the mbuf |
+| om | Pointer to mbuf. Can be head of a chain of mbufs, a single mbuf or a packet header mbuf |
+| data | Pointer to data buffer to copy from |
+| len | Number of bytes to copy from data buffer to the end of the mbuf |
<br>
@@ -22,8 +22,8 @@ Appends a data buffer of length `len` to the end of an mbuf chain, adjusting pac
#### Returned values
0: success
-`OS_ENOMEM`: Could not allocate enough mbufs to hold data.
-`OS_EINVAL`: `om` was **NULL** on entry.
+OS_ENOMEM: Could not allocate enough mbufs to hold data.
+OS_EINVAL: *om* was NULL on entry.
<br>
@@ -32,7 +32,7 @@ If not enough mbufs were available the packet header length of the mbuf may get
<br>
-If any mbufs are allocated, they are allocated from the same pool as `om`
+If any mbufs are allocated, they are allocated from the same pool as *om*
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_concat.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_concat.md b/docs/os/core_os/mbuf/os_mbuf_concat.md
index 5ef32fd..69df9f6 100644
--- a/docs/os/core_os/mbuf/os_mbuf_concat.md
+++ b/docs/os/core_os/mbuf/os_mbuf_concat.md
@@ -12,8 +12,8 @@ Attaches a second mbuf chain onto the end of the first. If the first chain conta
| Arguments | Description |
|-----------|-------------|
-| `first` | Pointer to first mbuf chain |
-| `second` | Pointer to second mbuf chain |
+| first | Pointer to first mbuf chain |
+| second | Pointer to second mbuf chain |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_copydata.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_copydata.md b/docs/os/core_os/mbuf/os_mbuf_copydata.md
index 25e24fe..ff2dcd0 100644
--- a/docs/os/core_os/mbuf/os_mbuf_copydata.md
+++ b/docs/os/core_os/mbuf/os_mbuf_copydata.md
@@ -4,7 +4,7 @@
int os_mbuf_copydata(const struct os_mbuf *m, int off, int len, void *dst)
```
-Copy data from an mbuf chain starting `off` bytes from the beginning, continuing for `len` bytes, into the indicated buffer.
+Copy data from an mbuf chain starting *off* bytes from the beginning, continuing for *len* bytes, into the indicated buffer.
<br>
@@ -12,10 +12,10 @@ Copy data from an mbuf chain starting `off` bytes from the beginning, continuing
| Arguments | Description |
|-----------|-------------|
-| `m` | Pointer to mbuf chain |
-| `off` | Start copy offset, in bytes, from beginning of mbuf chain |
-| `len` | Number of bytes to copy |
-| `dst` | Data buffer to copy into |
+| m | Pointer to mbuf chain |
+| off | Start copy offset, in bytes, from beginning of mbuf chain |
+| len | Number of bytes to copy |
+| dst | Data buffer to copy into |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_copyinto.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_copyinto.md b/docs/os/core_os/mbuf/os_mbuf_copyinto.md
index ed6dd68..6c18f57 100644
--- a/docs/os/core_os/mbuf/os_mbuf_copyinto.md
+++ b/docs/os/core_os/mbuf/os_mbuf_copyinto.md
@@ -12,10 +12,10 @@ Copies the contents of a flat buffer into an mbuf chain, starting at the specifi
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf chain |
-| `off` | Start copy offset, in bytes, from beginning of mbuf chain |
-| `src` | Address from which bytes are copied |
-| `len` | Number of bytes to copy from src |
+| om | Pointer to mbuf chain |
+| off | Start copy offset, in bytes, from beginning of mbuf chain |
+| src | Address from which bytes are copied |
+| len | Number of bytes to copy from src |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_dup.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_dup.md b/docs/os/core_os/mbuf/os_mbuf_dup.md
index df32960..13f9d9e 100644
--- a/docs/os/core_os/mbuf/os_mbuf_dup.md
+++ b/docs/os/core_os/mbuf/os_mbuf_dup.md
@@ -12,13 +12,13 @@ Duplicate a chain of mbufs. Return the start of the duplicated chain.
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf chain to duplicate |
+| om | Pointer to mbuf chain to duplicate |
<br>
#### Returned values
-Pointer to the duplicated chain or **NULL** if not enough mbufs were available to duplicate the chain.
+Pointer to the duplicated chain or NULL if not enough mbufs were available to duplicate the chain.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_extend.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_extend.md b/docs/os/core_os/mbuf/os_mbuf_extend.md
index 3db1001..3986e37 100644
--- a/docs/os/core_os/mbuf/os_mbuf_extend.md
+++ b/docs/os/core_os/mbuf/os_mbuf_extend.md
@@ -12,16 +12,16 @@ Increases the length of an mbuf chain by the specified amount. If there is not
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf chain |
-| `len` | Number of bytes to increase packet header |
+| om | Pointer to mbuf chain |
+| len | Number of bytes to increase packet header |
<br>
#### Returned values
-Pointer to start of extended data. Caller is guaranteed that there are at least `len` bytes from this pointer to the end of the mbuf.
+Pointer to start of extended data. Caller is guaranteed that there are at least *len* bytes from this pointer to the end of the mbuf.
-Returns **NULL** if extension fails due to insufficient mbufs or `len` too large.
+Returns NULL if extension fails due to insufficient mbufs or *len* too large.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_free_chain.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_free_chain.md b/docs/os/core_os/mbuf/os_mbuf_free_chain.md
index 17ec186..660fa5a 100644
--- a/docs/os/core_os/mbuf/os_mbuf_free_chain.md
+++ b/docs/os/core_os/mbuf/os_mbuf_free_chain.md
@@ -12,7 +12,7 @@ Frees a chain of mbufs
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf chain |
+| om | Pointer to mbuf chain |
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_get.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_get.md b/docs/os/core_os/mbuf/os_mbuf_get.md
index fe04dd6..96aa273 100644
--- a/docs/os/core_os/mbuf/os_mbuf_get.md
+++ b/docs/os/core_os/mbuf/os_mbuf_get.md
@@ -4,7 +4,7 @@
struct os_mbuf *os_mbuf_get(struct os_mbuf_pool *omp, uint16_t leadingspace)
```
-Get an mbuf from the mbuf pool. The mbuf is allocated, and initialized prior to being returned. The `eadingspace` parameter allows the user to specify the amount of leading space in the allocated mbuf.
+Get an mbuf from the mbuf pool. The mbuf is allocated, and initialized prior to being returned. The *leadingspace* parameter allows the user to specify the amount of leading space in the allocated mbuf.
<br>
@@ -13,14 +13,14 @@ Get an mbuf from the mbuf pool. The mbuf is allocated, and initialized prior to
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf pool from which to allocate mbuf |
-| `leadingspace` | Amount of leading space in allocated mbuf. Request cannot exceed the mbuf data buffer size. |
+| om | Pointer to mbuf pool from which to allocate mbuf |
+| leadingspace | Amount of leading space in allocated mbuf. Request cannot exceed the mbuf data buffer size. |
<br>
#### Returned values
-Returns a pointer to the allocated mbuf or **NULL** if there are no mbufs available or `leadingspace` was too large.
+Returns a pointer to the allocated mbuf or NULL if there are no mbufs available or *leadingspace* was too large.
<br>
#### Notes
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md b/docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md
index 304aef8..d975b4b 100644
--- a/docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md
+++ b/docs/os/core_os/mbuf/os_mbuf_get_pkthdr.md
@@ -4,7 +4,7 @@
struct os_mbuf *os_mbuf_get_pkthdr(struct os_mbuf_pool *omp, uint8_t pkthdr_len);
```
-Allocates a packet header mbuf from the mbuf pool pointed to by `omp`. Adds a user header of length `pkthdr_len` to packet header mbuf.
+Allocates a packet header mbuf from the mbuf pool pointed to by *omp*. Adds a user header of length *pkthdr_len* to packet header mbuf.
<br>
@@ -12,19 +12,19 @@ Allocates a packet header mbuf from the mbuf pool pointed to by `omp`. Adds a us
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf pool from which to allocate mbuf |
-| `pkthdr_len` | The user header packet length to allocate for the packet header mbuf |
+| om | Pointer to mbuf pool from which to allocate mbuf |
+| pkthdr_len | The user header packet length to allocate for the packet header mbuf |
<br>
#### Returned values
-Returns a pointer to the allocated mbuf or **NULL** if there are no mbufs available or the user packet header was too large.
+Returns a pointer to the allocated mbuf or NULL if there are no mbufs available or the user packet header was too large.
<br>
#### Notes
-The packet header mbuf returned will have its data pointer incremented by the `sizeof(struct os_mbuf_pkthdr)` as well as the amount of user header data (i.e. `pkthdr_len`). In other words, the data pointer is offset from the start of the mbuf by: `sizeof(struct os_mbuf)` + `sizeof(struct os_mbuf_pkthdr)` + `pkthdr_len`. The `om_pkthdr_len` element in the allocated mbuf is set to: `sizeof(struct os_mbuf_pkthdr)` + `pkthdr_len`.
+The packet header mbuf returned will have its data pointer incremented by the sizeof(struct os_mbuf_pkthdr) as well as the amount of user header data (i.e. *pkthdr_len*). In other words, the data pointer is offset from the start of the mbuf by: sizeof(struct os_mbuf) + sizeof(struct os_mbuf_pkthdr) + pkthdr_len. The `om_pkthdr_len` element in the allocated mbuf is set to: sizeof(struct os_mbuf_pkthdr) + pkthdr_len.
<br>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/1720300a/docs/os/core_os/mbuf/os_mbuf_memcmp.md
----------------------------------------------------------------------
diff --git a/docs/os/core_os/mbuf/os_mbuf_memcmp.md b/docs/os/core_os/mbuf/os_mbuf_memcmp.md
index b2315c9..20ca328 100644
--- a/docs/os/core_os/mbuf/os_mbuf_memcmp.md
+++ b/docs/os/core_os/mbuf/os_mbuf_memcmp.md
@@ -12,10 +12,10 @@ Performs a memory compare of the specified region of an mbuf chain against a fla
| Arguments | Description |
|-----------|-------------|
-| `om` | Pointer to mbuf |
-| `off` | Offset, in bytes, from start of mbuf to start of comparison |
-| `data` | Pointer to flat data buffer to compare |
-| `len` | Number of bytes to compare |
+| om | Pointer to mbuf |
+| off | Offset, in bytes, from start of mbuf to start of comparison |
+| data | Pointer to flat data buffer to compare |
+| len | Number of bytes to compare |
<br>
@@ -25,7 +25,7 @@ A value of zero means the memory regions are identical; all other values represe
<br>
#### Notes
-This function will compare bytes starting from `off` bytes from the start of the mbuf chain with a data buffer.
+This function will compare bytes starting from *off* bytes from the start of the mbuf chain with a data buffer.
<br>