doc: update the doc

* add doc for release 2018.09
* fix typos
* optimize the doc

Signed-off-by: Wayne Ren <[email protected]>

Author: Wayne Ren

doc/documents/changelog/changelog.rst

@@ -27,6 +27,7 @@ embARC OSP Releases
 .. toctree::
    :maxdepth: 1
 
+   release_2018.09.rst
    release_2017.12.rst
    release_2017.03.rst
    release_2016.05.rst

doc/documents/changelog/release_2017.12.rst

@@ -15,7 +15,7 @@ Features and Enhancements
 #########################
 
 * Main new features
-  
+
   * Add support for new ARC HS Development Kit (HSDK) platform
   * Reconstruct the device HAL
 

doc/documents/changelog/release_2018.09.rst

@@ -0,0 +1,53 @@
+.. _release_2018.09:
+
+Release 2018.09
+===============
+
+This is the seventh release of the embARC Open Software Platform, release 2018.09.
+
+Tool Support
+############
+
+* GNU Toolchain for ARC Processors, 2018.03
+* MetaWare Development Toolkit, 2018.06
+
+Features and Enhancements
+#########################
+
+* Main new features
+  * Support for new ARC IoT Development Kit (IoTDK) platform
+* Device HAL updates
+  * Support for ARC Data Fusion and Sensor and Control Subsystem drivers and corresponding wrappers (under device/ip/subsystem)
+  * Support for DesignWare I2S driver
+  * Support for UART-BLE module RN4020
+  * Support for IMU sensor module MPU9250
+* ARC HAL updates
+  * Bugs fixes
+* Board support updates
+  * Support for new ARC IoT Development Kit (IoTDK platform)
+* Middleware updates
+  * No update
+* OS updates
+  * No update
+* Examples update
+  * Add new examples for RN420 and MPU9250 modules
+* Documentation updates
+* Bug fixes
+* FOSS notice update
+
+How to Use
+##########
+
+Please refer to the doc folder in the release zip file and `Getting Started <https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/wiki/Getting-Started-with-embARC-OSP>`_.
+
+Known Issues
+############
+
+* This release has changed a lot in device layer, with the peripheral layer introduced, many examples which rely on old peripheral drivers in emsk will not be compatible with new embARC OSP, please modify it.
+* Make version >=4.0 is not supported. Please use make version 3.81 or 3.82
+* For Wifi applications, the Digilent pmod Wifi with Microchip part MRF24WG0MA should be used. Pmods built with MRF24WB0MA have been shown to experience problems and are NOT supported.
+* Please don't put embARC source code too deep in your directory, because some examples can't be compiled due to too long command line not supported in Windows.
+* Since brand new device hal API is upgraded, your application that use the old device hal API need to be upgraded.
+* Secureshield library need MPU hardware module on EMSK, check your hardware configuration of EMSK before using it.
+* Please use the recommended tool versions for metaware and arc gnu.
+* For ARC GNU, an utility called **tcftool** from Metaware toolset is required for tcf build support. You can get it from Metaware Lite and copy it to ARC GNU's folder such as *C:/arc_gnu/bin/*.

doc/documents/developer/application_development.rst

@@ -12,9 +12,8 @@ provded examples and demos, e.g. the example in
 ``<embARC>/example/baremetal/bootloader`` for the EMSK 2.2 board and ARC EM7D
 core configuration.
 
-    1. Go to the example directory, ``cd
-    <embARC>/example/baremetal/bootloader``. ``<embARC>``should be replaced by
-    your actual path such as ``c:/embARC``. Use ``\`` instead of ``/`` in the
+    1. Go to the example directory, ``cd <embARC>/example/baremetal/bootloader`` . ``<embARC>`` should be replaced by
+    your actual path such as ``c:/embARC`` . Use ``\`` instead of ``/`` in the
     Windows environment.
 
     2. Run the ``make`` commands

doc/documents/getting_started/getting_started.rst

@@ -51,13 +51,11 @@ Use the following procedure to create a new development environment
 Building a Sample Application
 #############################
 
-Using the ``blinky`` example, the following section will describe how
-to build an embARC OSP application. The following sections contain the commands
-used for the ARC GNU toolchain in a Windows environment. Please use the
+Using the ``blinky`` example, the following steps, which contains the commands
+used for the ARC GNU toolchain in a Windows environment, will describe how
+to build an embARC OSP application. Please use the
 appropriate commands for your OS.
 
-Follow these steps to build a sample application
-
 1. Make sure the ARC GNU toolchain is installed in your environment, see :ref:`software_requirement`.
 
 2. Navigate to :ref:`example_blinky` example located at embARC OSP directory.
@@ -110,7 +108,7 @@ Follow these steps to run the sample application.
    cd embarc_osp\example\baremetal\blinky
    make TOOLCHAIN=gnu BOARD=emsk BD_VER=23 CUR_CORE=arcem11d run
 
-.. note:: No peripheral modules are required to run the ``blinky`` example.
+.. note:: No peripheral modules are required to run the ``blinky`` example. If there are LEDs on boards, these LED will be used to blink; If there are no LEDs on boards, a blink message will be output in the UART.
 
 See the following manual for information on make/gmake command and embARC makefile system.
 

doc/documents/getting_started/peripheral_preparation.rst

@@ -32,7 +32,7 @@ Now your code should be like this:
 
 .. note:: Notice that **UR** means Upper Layer of Pmod interface and **LR** means Lower Layer of Pmod
 
-3. If you are using HSDK, go to mux.c and find ``io_mux_init()`` function, you will find it calls ``creg_hsdc_set_gpio_mux()`` with paramater array ``gpio_mux_config`` as MUX options.
+3. If you are using HSDK, go to mux.c and find ``io_mux_init()`` function, you will find it calls ``creg_hsdc_set_gpio_mux()`` with parameter array ``gpio_mux_config`` as MUX options.
 By default all pins are set to GPIO, other MUX options are defined in ``PINMUX_TYPE`` in ``embarc_osp/device/inc/dev_pinmux.h``
 
 4. If you are using IoTDK, go to mux.c and find ``int32_t  io_pmod_config(uint32_t pmod, uint32_t type, uint32_t config)`` function.
@@ -71,4 +71,5 @@ Driver code at ``embarc_osp/device/peripheral/adc/ad7991``.
 
 `ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ : Primary IC type is ESP8266, use **UART** interface for data changing and controlling.
 Driver code at ``embarc_osp/device/peripheral/wifi/slip_esp``.
-	The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD campatible, meaning that you could wire it to PMOD interface on board. You need to connect GCC(embARC) to GCC(ESP) , 3.3V(embARC) to VCC, RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.
+
+The ESP01/ESP01S module is not originally a PMOD module, however it is PMOD compatible, meaning that you could wire it to PMOD interface on board. You need to connect GCC(embARC) to GCC(ESP) , 3.3V(embARC) to VCC, RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <http://wiki.ai-thinker.com/esp8266/docs>`_ and UART (type 4A) part of `Digilent Pmod Spec <https://www.digilentinc.com/Pmods/Digilent-Pmod_%20Interface_Specification.pdf>`_ for pin layout.

doc/documents/introduction/introduction.rst

@@ -60,8 +60,6 @@ in the block diagram below.
    how to obtain these packages for use with embARC
 
    - For secure communication, see :ref:`mbed TLS<middleware_mbedtls>`
-   - FOr MQX support, see :ref:`MQX support<os_mqx>`
-
 
 - :ref:`ARC Hardware Abstraction Layer (ARC HAL)<arc_hal>` provides the
   necessary hardware abstraction for |arc| ISA compatible processors.

doc/documents/lib/c_lib.rst

@@ -3,7 +3,7 @@
 C Library Support
 #################
 
-Provides support for file-related APIs using FatFs, printf() support using a
+Provides support for file-related APIs using FatFs, **printf()** support using a
 UART, and time-related APIs. For details, please refer to the source code in
 ``library/clib``. The C library support implemented in embARC OSP is
 compatible with both the GNU toolchain for ARC Processors and the MetaWare

doc/documents/lib/secureshield.rst

@@ -166,11 +166,11 @@ or memory. The access-control attribute describes how it is accessed: secure
 or normal, read/write/execute. The detailed definitions of resource type and
 access-control attribute is listed as follow.
 
-.. csv-table:: Container Resoure Type
+.. csv-table:: Container Resource Type
     :file: container_resources_type.csv
     :header-rows: 1
 
-.. csv-table:: Container Resoure Attribute
+.. csv-table:: Container Resource Attribute
     :file: container_resources_attribute.csv
     :header-rows: 1
 
@@ -211,8 +211,8 @@ services. The following SecureShield runtime services are provided:
             res; \
         })
 
-If SECURESHIELD_VERSION == 1, SECURE_INSTN is trap_s; If SECURESHIELD_VERSION
-== 2, SECURE_INSTN is sjli.
+If SECURESHIELD_VERSION == 1, SECURE_INSTN is **trap_s**; If SECURESHIELD_VERSION
+== 2, SECURE_INSTN is **sjli**.
 
 Container Call
 ^^^^^^^^^^^^^^

doc/documents/middleware/misc/common.rst

@@ -3,6 +3,6 @@
 Common
 ######
 
-Common middleware consists of ringbuffer and ``xprintf()`` packages;
+Common middleware consists of ring buffer and ``xprintf()`` packages;
 ``xprintf()`` is a lightweight printf() library used in embedded systems
 without support for floating point.