Merge pull request #127 from wangnuannuan/feature/modify_doc

doc: modify punctuation and spelling

Author: YuguoWH

device/ip/ip_hal/inc/dev_gpio.h

@@ -32,7 +32,7 @@
  * \defgroup	DEVICE_HAL_GPIO		GPIO Device HAL Interface
  * \ingroup	DEVICE_HAL_DEF
  * \brief	definitions for gpio device hardware layer (\ref dev_gpio.h)
- * \details	provide interfaces for gpio driver to implement
+ * \details	Provide interfaces for gpio driver to implement
  *  Here is a diagram for the gpio interface.
  *
  *  \htmlonly
@@ -382,7 +382,7 @@ typedef struct dev_gpio_bit_isr {
  */
 /**
  * \brief	gpio information struct definition
- * \details	informations about gpio open count, working status
+ * \details	Informations about gpio open count, working status
  * 	gpio registers and control block, gpio io direction and interrupt/poll for each bit of gpio
  * \note	Only available for gpio with max 32bits
  */
@@ -410,9 +410,9 @@ typedef struct dev_gpio_info {
 
 /**
  * \brief	gpio device interface definition
- * \details	define gpio device interface, like gpio information structure,
+ * \details	Define gpio device interface, like gpio information structure,
  * 	fuctions to open/close/control gpio, write or read data via gpio
- * \note	all this details are implemented by user in user porting code
+ * \note	All this details are implemented by user in user porting code
  */
 typedef struct dev_gpio {
 	DEV_GPIO_INFO gpio_info;		/*!< gpio device information */
@@ -437,7 +437,7 @@ typedef struct dev_gpio {
 
 /**
  * \fn		int32_t (* dev_gpio::gpio_close) (void)
- * \details	Close an gpio device, just decrease the \ref dev_gpio_info::opn_cnt "opn_cnt",
+ * \details	Close a gpio device, just decrease the \ref dev_gpio_info::opn_cnt "opn_cnt",
  *      if \ref dev_gpio_info::opn_cnt "opn_cnt" equals 0, then close the device
  * \retval	E_OK	Close successfully without any issues(including scenario that device is already closed)
  * \retval	E_OPNED	Device is still opened, the device \ref dev_gpio_info::opn_cnt "opn_cnt" decreased by 1
@@ -495,7 +495,7 @@ extern "C" {
  * \param[in]	gpio_id	id of gpio, defined by user
  * \retval	!NULL	pointer to an \ref dev_gpio "gpio device structure"
  * \retval	NULL	failed to find the gpio device by \ref gpio_id
- * \note	need to implemented by user in user code
+ * \note	Need to implemented by user in user code
  */
 extern DEV_GPIO_PTR gpio_get_dev(int32_t gpio_id);
 

doc/documents/board/emsk.rst

@@ -19,7 +19,7 @@ The EMSK consists of a hardware platform and a software package, including
 pre-installed FPGA images of different configurations of the ARC EM Processor
 with peripherals.
 
-The development board is based on a Xilinx Spartan®-6 LX45 FPGA. It
+The development board is based on a Xilinx Spartan-6 LX45 FPGA. It
 supports hardware extensions using six 2x6 connectors supporting a total of 48
 user I/O pins (plus power and ground pins) that can be used to connect
 components such as sensors, actuators, memories, displays, buttons, switches,
@@ -163,7 +163,7 @@ Required Hardware and Software
 To use embARC OSP applications on the IoTDK board, the following items are required
 
 * USB Cable
-* The USB cable provides power to the board (maximum 500 mA); however, if the board is to run
+* The USB cable provides power to the board (maximum 500 mA). However, if the board is to run
   standalone, the universal switching power adaptor (110-240V AC to 5V DC),
   can be used to power the board
 * :ref:`software_requirement`.

doc/documents/changelog/release_2016.05.rst

@@ -26,7 +26,7 @@ Features and Enhancements
 
 * Add library support
 
-  * `dlmalloc <http://g.oswego.edu/dl/html/malloc.html>`_
+  * `dlmalloc <http://gee.cs.oswego.edu/dl/html/malloc.html>`_
   * MetaWare standard c library for MetaWare toolchain
   * newlib c library for ARC GNU toolchain
 

doc/documents/conf.py

@@ -182,7 +182,8 @@
 intersphinx_mapping = {'https://docs.python.org/': None}
 
 linkcheck_ignore = [
-    'http://www.solomon-systech.com/en/product/display-ic/oled-driver-controller/ssd1306/', 
+    'http://www.solomon-systech.com/en/product/display-ic/oled-driver-controller/ssd1306/',
+    'http://elm-chan.org/', 
 ]
 
 rst_epilog =  u"""

doc/documents/device/gpio.rst

@@ -3,7 +3,7 @@
 GPIO HAL
 ========
 
-The GPIO HAL definitions is in ``dev_gpio.h``, it provide interfaces for gpio
+The GPIO HAL definitions are in ``dev_gpio.h``, it provides interfaces for gpio
 driver to implement. Here is a diagram for the gpio interface.
 
 .. image:: /pic/dev_gpio_hal.jpg

doc/documents/getting_started/makefile_manual.rst

@@ -110,7 +110,7 @@ The basic way of this command is to enter ``make cfg``, the makefile system will
 	"Debug Jtags (JTAG)             : usb opella"
 
 At supported Configurations, you can find different choices for your command, the uppercase words in parentheses are paramater names to be used in your command.
-For example, the command below will execute your command for an *EMSK* board with *arcem7d* core, toolchain would be *gnu* and JTAG connection is via *USB*.
+For example, the command below will execute your command for an *EMSK* board with *arcem7d* core, toolchain will be *gnu* and JTAG connection is via *USB*.
 
 .. code-block:: console
 
@@ -151,7 +151,7 @@ build
 
 This command will clean and build the project with selected paramaters.
 
-Here is a example using EMSK (version 1.1, arcem6 core), compiled with gnu.
+Here is an example using EMSK (version 1.1, arcem6 core), compiled with gnu.
 
 .. code-block:: console
 
@@ -184,7 +184,7 @@ Here is a example using IoTDK (version 1.0, arcem9d core), compiled with Metawar
 
 	make BOARD=iotdk BD_VER=10 CUR_CORE=arcem9d TOOLCHAIN=mw JTAG=usb run
 
-You may also use it wiout BD_VER and CUR_CORE options since they are default options.
+You may also use it without BD_VER and CUR_CORE options since they are default options.
 
 .. code-block:: console
 
@@ -207,9 +207,9 @@ This command will clean the directory, removing all object files of all boards.
 Useful Options
 ##############
 
-#. Boards (**BOARD**): Use this option to check config for different boards. Usually he default BOARD setting is EMSK.
-#. Core Configurations (**CUR_CORE**): shows available core choices.
-#. Build Toolchains (**TOOLCHAIN**):To choose from different toolchain.
-#. Debug Jtags (**JTAG**): In most case the micro-usb interface on board supports JTAG debugging. Ashling's Opella-XD-ARC is also support by some boards.
+#. Boards (**BOARD**): Use this option to check config for different boards. Usually the default BOARD setting is EMSK.
+#. Core Configurations (**CUR_CORE**): Shows available core choices.
+#. Build Toolchains (**TOOLCHAIN**):To choose from different toolchains.
+#. Debug Jtags (**JTAG**): In most case the micro-usb interface on board supports JTAG debugging. Ashling's Opella-XD-ARC is also supported by some boards.
 #. Board version (**BD_VER**): Often used by EMSK which has many versions.
 

doc/documents/getting_started/peripheral_preparation.rst

@@ -14,9 +14,9 @@ We will take PMOD interface as example to explain the setting method. Other inte
 [board_type] should be replaced to board type name, such as *emsk*, *hsdk* or *iotdk*.
 
 2. If you are using EMSK, go to mux.c and find ``io_mux_init()`` function, you will see it calls ``set_pmod_mux()`` with MUX options as parameters.
-MUX options are defined in mux.h and you could change them as you see fit.
+MUX options are defined in mux.h and you can change them as you see fit.
 
-For example, You want to connect your EMSK with two i2c sensor modules. By default setting you only have PM2 as i2c interface.
+For example, you want to connect your EMSK with two i2c sensor modules. By default setting you only have PM2 as i2c interface.
 So now you have to check mux.h or EMSK manual to see if it support one more i2c interface.
 Notice that there is a ``PM3_I2C_GPIO_D`` macro in mux.h meaning that PM3 support i2c interface. Now all you need to do is to replace the default PM3 setting in ``set_pmod_mux()`` to ``PM3_I2C_GPIO_D``.
 Now your code should be like this:
@@ -43,7 +43,7 @@ All three parameters should use definitions in ``embarc_osp/device/inc/dev_pinmu
 	* The third parameter should be ``IO_PINMUX_ENABLE`` or ``IO_PINMUX_DISABLE``, enabling or disabling the mux controller respectively.
 
 5. If you are using EMSDP, go to mux.c and find ``io_mux_init()`` function, you will find it calls ``set_pmod_mux()`` with MUX options as parameters.
-MUX options are defined in mux.h and you could change them as you see fit.
+MUX options are defined in mux.h and you can change them as you see fit.
 
 .. note:: In EMSDP, notice that **CFG0** means Upper Layer of Pmod interface and **CFG1** means Lower Layer of Pmod
 
@@ -63,10 +63,10 @@ Driver code at ``embarc_osp/device/peripheral/wifi/rw009``.
 
 PMOD Temperature Module
 ***********************
-`Pmod TMP2 <https://reference.digilentinc.com/reference/pmod/pmodtmp2/start>`_ : sensor chip type is ADT7420, use **I2C** for data collection.
+`Pmod TMP2 <https://reference.digilentinc.com/reference/pmod/pmodtmp2/start>`_ : Sensor chip type is ADT7420, use **I2C** for data collection.
 Driver code at ``embarc_osp/device/peripheral/sensor/temperature/adt7420``.
 
-`Pmod TMP3 <https://reference.digilentinc.com/reference/pmod/pmodtmp3/start>`_ : sensor chip type is TCN75A, use **I2C** for data collection.
+`Pmod TMP3 <https://reference.digilentinc.com/reference/pmod/pmodtmp3/start>`_ : Sensor chip type is TCN75A, use **I2C** for data collection.
 Driver code at ``embarc_osp/device/peripheral/sensor/temperature/tcn75``.
 
 Other PMOD or Compatible Modules
@@ -77,4 +77,4 @@ Driver code at ``embarc_osp/device/peripheral/adc/ad7991``.
 `ESP01\/ESP01S <https://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 compatible, meaning that you could wire it to PMOD interface on board. You need to connect GND(embARC) to GND(ESP) , 3.3V(embARC) to VCC(ESP), RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <https://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 can wire it to PMOD interface on board. You need to connect GND(embARC) to GND(ESP) , 3.3V(embARC) to VCC(ESP), RXD(embARC) to TXD(ESP), and TXD(embARC) to RXD(ESP), respectively. Please take reference from datasheet of `ESP01\/ESP01S <https://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/getting_started/software_requirement.rst

@@ -12,7 +12,7 @@ Development Environment
 
 Software Requirement
 ####################
-* `ARC Development Tools <https://www.synopsys.com/designware-ip/processor-solutions/arc-processors/arc-development-tools.html>`_
+* `ARC Development Tools <https://www.synopsys.com/designware-ip/processor-solutions/arc-development-tools.html>`_
     Choose **MetaWare Toolkit** and/or **ARC GNU Toolchain** from the following list according to your requirement:
 
   * MetaWare Toolkit

doc/documents/license/license.rst

@@ -92,8 +92,8 @@ Doxygen
 Dlmalloc
 ********
 
-:Project homepage: http://g.oswego.edu/dl/html/malloc.html
-:Project licensing: http://g.oswego.edu/dl/html/malloc.html
+:Project homepage: http://gee.cs.oswego.edu/dl/html/malloc.html
+:Project licensing: http://gee.cs.oswego.edu/dl/html/malloc.html
 :LICENSE: `Creative Commons CC0 1.0 Universal`_
 
 FatFS

example/baremetal/ble_hm1x/README.rst

@@ -13,7 +13,7 @@ Detailed Description
  * Extra Required Tools
     BLE APP on SmartPhone:
         - Android: BLE Android ComAssistant
-        - iOS: `LightBlue <https://itunes.apple.com/us/app/lightblue-bluetooth-low-energy/id557428110?mt=8>`_
+        - iOS: `LightBlue <https://apps.apple.com/us/app/lightblue-bluetooth-low-energy/id557428110>`_
 
  * Extra Required Peripherals
     UART Based BLE Device HM-10