Skip to content
Permalink
Browse files

init: refactor the repo to reduce the size

Signed-off-by: Wayne Ren <wei.ren@synopsys.com>
  • Loading branch information...
Wayne Ren
Wayne Ren committed Jun 22, 2018
0 parents commit b6b266cd251f50d395d016ecdc8290892f89dd90
Showing with 44,610 additions and 0 deletions.
  1. +53 −0 .github/CONTRIBUTING.md
  2. +226 −0 .github/CONTRIBUTING_APPLICATIONS.md
  3. +40 −0 .github/ISSUE_TEMPLATE.md
  4. +51 −0 .github/ISSUE_TEMPLATE/bug_report.md
  5. +17 −0 .github/ISSUE_TEMPLATE/feature_request.md
  6. +11 −0 .github/PULL_REQUEST_TEMPLATE.md
  7. BIN .github/img/cmd_make.PNG
  8. BIN .github/img/compare_across_forks.PNG
  9. BIN .github/img/compare_changes.PNG
  10. BIN .github/img/create_pull_request.PNG
  11. BIN .github/img/device_manager.PNG
  12. BIN .github/img/digilent_adapt.PNG
  13. BIN .github/img/document_folder.PNG
  14. BIN .github/img/doxygen_make.PNG
  15. BIN .github/img/embarc_document.PNG
  16. BIN .github/img/example_usage_guide.PNG
  17. BIN .github/img/fork_app_repo.PNG
  18. BIN .github/img/gnu_make.PNG
  19. BIN .github/img/new_pull_request.PNG
  20. BIN .github/img/tera_term.PNG
  21. BIN .github/img/zadig.PNG
  22. +66 −0 .gitignore
  23. +33 −0 README.md
  24. +11 −0 aws_iot_smarthome/LICENSE
  25. +115 −0 aws_iot_smarthome/README.md
  26. +237 −0 aws_iot_smarthome/dashboard-smarthome-singlething.json
  27. BIN aws_iot_smarthome/doc/screenshots/emsk_connections.jpg
  28. BIN aws_iot_smarthome/doc/screenshots/run_cmd.jpg
  29. BIN aws_iot_smarthome/doc/screenshots/webapp.jpg
  30. BIN aws_iot_smarthome/doc/screenshots/webapp_setting1.jpg
  31. BIN aws_iot_smarthome/doc/screenshots/webapp_setting2.jpg
  32. +113 −0 aws_iot_smarthome/src/FreeRTOSConfig.h
  33. +56 −0 aws_iot_smarthome/src/aws_iot_config.h
  34. +3 −0 aws_iot_smarthome/src/cert/smarthome/cert.crt
  35. +3 −0 aws_iot_smarthome/src/cert/smarthome/privateKey.pem
  36. +3 −0 aws_iot_smarthome/src/cert/smarthome/rootCA.crt
  37. +453 −0 aws_iot_smarthome/src/lwipopts.h
  38. +768 −0 aws_iot_smarthome/src/main.c
  39. +50 −0 aws_iot_smarthome/src/makefile
  40. +2,495 −0 aws_iot_smarthome/src/mbedtls_config.h
  41. +36 −0 aws_iot_smarthome/src/ssd1306_app_config.h
  42. +11 −0 aws_iot_smarthome_multinode/LICENSE
  43. +71 −0 aws_iot_smarthome_multinode/README.md
  44. +275 −0 aws_iot_smarthome_multinode/dashboard-smarthome-multithings.json
  45. BIN aws_iot_smarthome_multinode/doc/screenshots/emsk_connections.jpg
  46. BIN aws_iot_smarthome_multinode/doc/screenshots/webapp.jpg
  47. BIN aws_iot_smarthome_multinode/doc/screenshots/webapp_setting1.jpg
  48. BIN aws_iot_smarthome_multinode/doc/screenshots/webapp_setting2.jpg
  49. +3 −0 aws_iot_smarthome_multinode/src/cert/frontdoor/cert.crt
  50. +3 −0 aws_iot_smarthome_multinode/src/cert/frontdoor/privateKey.pem
  51. +3 −0 aws_iot_smarthome_multinode/src/cert/frontdoor/rootCA.crt
  52. +3 −0 aws_iot_smarthome_multinode/src/cert/kitchen/cert.crt
  53. +3 −0 aws_iot_smarthome_multinode/src/cert/kitchen/privateKey.pem
  54. +3 −0 aws_iot_smarthome_multinode/src/cert/kitchen/rootCA.crt
  55. +3 −0 aws_iot_smarthome_multinode/src/cert/livingRoom/cert.crt
  56. +3 −0 aws_iot_smarthome_multinode/src/cert/livingRoom/privateKey.pem
  57. +3 −0 aws_iot_smarthome_multinode/src/cert/livingRoom/rootCA.crt
  58. +113 −0 aws_iot_smarthome_multinode/src/frontDoor/FreeRTOSConfig.h
  59. +56 −0 aws_iot_smarthome_multinode/src/frontDoor/aws_iot_config.h
  60. +453 −0 aws_iot_smarthome_multinode/src/frontDoor/lwipopts.h
  61. +535 −0 aws_iot_smarthome_multinode/src/frontDoor/main.c
  62. +40 −0 aws_iot_smarthome_multinode/src/frontDoor/makefile
  63. +2,495 −0 aws_iot_smarthome_multinode/src/frontDoor/mbedtls_config.h
  64. +113 −0 aws_iot_smarthome_multinode/src/kitchen/FreeRTOSConfig.h
  65. +56 −0 aws_iot_smarthome_multinode/src/kitchen/aws_iot_config.h
  66. +453 −0 aws_iot_smarthome_multinode/src/kitchen/lwipopts.h
  67. +506 −0 aws_iot_smarthome_multinode/src/kitchen/main.c
  68. +40 −0 aws_iot_smarthome_multinode/src/kitchen/makefile
  69. +2,495 −0 aws_iot_smarthome_multinode/src/kitchen/mbedtls_config.h
  70. +113 −0 aws_iot_smarthome_multinode/src/livingRoom/FreeRTOSConfig.h
  71. +56 −0 aws_iot_smarthome_multinode/src/livingRoom/aws_iot_config.h
  72. +453 −0 aws_iot_smarthome_multinode/src/livingRoom/lwipopts.h
  73. +505 −0 aws_iot_smarthome_multinode/src/livingRoom/main.c
  74. +40 −0 aws_iot_smarthome_multinode/src/livingRoom/makefile
  75. +2,495 −0 aws_iot_smarthome_multinode/src/livingRoom/mbedtls_config.h
  76. +11 −0 ibaby_smarthome_multinode/LICENSE
  77. +304 −0 ibaby_smarthome_multinode/README.md
  78. BIN ibaby_smarthome_multinode/doc/screenshots/freeboard_ui.png
  79. BIN ibaby_smarthome_multinode/doc/screenshots/ibaby_function.PNG
  80. BIN ibaby_smarthome_multinode/doc/screenshots/lamp_work_info.PNG
  81. BIN ibaby_smarthome_multinode/doc/screenshots/lwm2m_started_info.PNG
  82. BIN ibaby_smarthome_multinode/doc/screenshots/system_architecture.PNG
  83. BIN ibaby_smarthome_multinode/doc/screenshots/wearable_node.jpg
  84. BIN ibaby_smarthome_multinode/doc/screenshots/wifi_connected_info.PNG
  85. +113 −0 ibaby_smarthome_multinode/src/lamp_node/FreeRTOSConfig.h
  86. +115 −0 ibaby_smarthome_multinode/src/lamp_node/driver/btn/btn.c
  87. +48 −0 ibaby_smarthome_multinode/src/lamp_node/driver/btn/btn.h
  88. +88 −0 ibaby_smarthome_multinode/src/lamp_node/driver/lamp/lamp.c
  89. +51 −0 ibaby_smarthome_multinode/src/lamp_node/driver/lamp/lamp.h
  90. +80 −0 ibaby_smarthome_multinode/src/lamp_node/function/common.h
  91. +89 −0 ibaby_smarthome_multinode/src/lamp_node/function/lamp_work/lamp_work.c
  92. +49 −0 ibaby_smarthome_multinode/src/lamp_node/function/lamp_work/lamp_work.h
  93. +159 −0 ibaby_smarthome_multinode/src/lamp_node/function/lwm2m/lwm2m.c
  94. +49 −0 ibaby_smarthome_multinode/src/lamp_node/function/lwm2m/lwm2m.h
  95. +67 −0 ibaby_smarthome_multinode/src/lamp_node/function/print_msg/print_msg.c
  96. +49 −0 ibaby_smarthome_multinode/src/lamp_node/function/print_msg/print_msg.h
  97. +367 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/liblwm2m.c
  98. +662 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/liblwm2m.h
  99. +452 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/lwipopts.h
  100. +843 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/lwm2mclient.c
  101. +107 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/lwm2mclient.h
  102. +256 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_connectivity_stat.c
  103. +629 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_device.c
  104. +416 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_firmware.c
  105. +280 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_flag_lamp_work.c
  106. +478 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_security.c
  107. +426 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/object_server.c
  108. +79 −0 ibaby_smarthome_multinode/src/lamp_node/lwm2m_client/system_api.c
  109. +112 −0 ibaby_smarthome_multinode/src/lamp_node/main.c
  110. +44 −0 ibaby_smarthome_multinode/src/lamp_node/makefile
  111. +113 −0 ibaby_smarthome_multinode/src/wearable_node/FreeRTOSConfig.h
  112. +226 −0 ibaby_smarthome_multinode/src/wearable_node/driver/acceleration/acceleration.c
  113. +70 −0 ibaby_smarthome_multinode/src/wearable_node/driver/acceleration/acceleration.h
  114. +217 −0 ibaby_smarthome_multinode/src/wearable_node/driver/body_temperature/body_temperature.c
  115. +57 −0 ibaby_smarthome_multinode/src/wearable_node/driver/body_temperature/body_temperature.h
  116. +312 −0 ibaby_smarthome_multinode/src/wearable_node/driver/heartrate/heartrate.c
  117. +58 −0 ibaby_smarthome_multinode/src/wearable_node/driver/heartrate/heartrate.h
  118. +128 −0 ibaby_smarthome_multinode/src/wearable_node/driver/timer/timer1.c
  119. +65 −0 ibaby_smarthome_multinode/src/wearable_node/driver/timer/timer1.h
  120. +91 −0 ibaby_smarthome_multinode/src/wearable_node/function/common.h
  121. +159 −0 ibaby_smarthome_multinode/src/wearable_node/function/lwm2m/lwm2m.c
  122. +49 −0 ibaby_smarthome_multinode/src/wearable_node/function/lwm2m/lwm2m.h
  123. +147 −0 ibaby_smarthome_multinode/src/wearable_node/function/print_msg/print_msg.c
  124. +55 −0 ibaby_smarthome_multinode/src/wearable_node/function/print_msg/print_msg.h
  125. +445 −0 ibaby_smarthome_multinode/src/wearable_node/function/process_acc/process_acc.c
  126. +75 −0 ibaby_smarthome_multinode/src/wearable_node/function/process_acc/process_acc.h
  127. +253 −0 ibaby_smarthome_multinode/src/wearable_node/function/process_hrate/process_hrate.c
  128. +49 −0 ibaby_smarthome_multinode/src/wearable_node/function/process_hrate/process_hrate.h
  129. +367 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/liblwm2m.c
  130. +662 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/liblwm2m.h
  131. +452 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/lwipopts.h
  132. +958 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/lwm2mclient.c
  133. +114 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/lwm2mclient.h
  134. +255 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_btemp.c
  135. +256 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_connectivity_stat.c
  136. +629 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_device.c
  137. +265 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_event_awake.c
  138. +416 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_firmware.c
  139. +256 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_hrate.c
  140. +263 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_motion_intensity.c
  141. +478 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_security.c
  142. +426 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_server.c
  143. +264 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_state.c
  144. +263 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_warn_btemp.c
  145. +265 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_warn_downward.c
  146. +263 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/object_warn_hrate.c
  147. +79 −0 ibaby_smarthome_multinode/src/wearable_node/lwm2m_client/system_api.c
  148. +129 −0 ibaby_smarthome_multinode/src/wearable_node/main.c
  149. +44 −0 ibaby_smarthome_multinode/src/wearable_node/makefile
  150. +11 −0 ilight_smartdevice/LICENSE
  151. +223 −0 ilight_smartdevice/README.md
  152. BIN ilight_smartdevice/doc/screenshots/app_weather.png
  153. BIN ilight_smartdevice/doc/screenshots/board_design.png
  154. BIN ilight_smartdevice/doc/screenshots/control_method.png
  155. BIN ilight_smartdevice/doc/screenshots/equipment.png
  156. BIN ilight_smartdevice/doc/screenshots/hard_ware.JPG
  157. +113 −0 ilight_smartdevice/src/FreeRTOSConfig.h
  158. +199 −0 ilight_smartdevice/src/driver/imu_driver/mpu6050.c
  159. +73 −0 ilight_smartdevice/src/driver/imu_driver/mpu6050.h
  160. +333 −0 ilight_smartdevice/src/driver/light_driver/light_driver.c
  161. +92 −0 ilight_smartdevice/src/driver/light_driver/light_driver.h
  162. +278 −0 ilight_smartdevice/src/driver/rtc_driver/rtc.c
  163. +100 −0 ilight_smartdevice/src/driver/rtc_driver/rtc.h
  164. +84 −0 ilight_smartdevice/src/driver/word_driver/word.c
  165. +54 −0 ilight_smartdevice/src/driver/word_driver/word.h
  166. +415 −0 ilight_smartdevice/src/function/ble/ble_int.c
  167. +57 −0 ilight_smartdevice/src/function/ble/ble_int.h
  168. +474 −0 ilight_smartdevice/src/function/imu/imu.c
  169. +86 −0 ilight_smartdevice/src/function/imu/imu.h
  170. +1,138 −0 ilight_smartdevice/src/function/light/light_mode.c
  171. +82 −0 ilight_smartdevice/src/function/light/light_mode.h
  172. +113 −0 ilight_smartdevice/src/function/mic/fft.c
  173. +128 −0 ilight_smartdevice/src/function/mic/fft.h
  174. +151 −0 ilight_smartdevice/src/function/mic/fft_list.c
  175. +447 −0 ilight_smartdevice/src/function/mic/fft_tab.c
  176. +86 −0 ilight_smartdevice/src/function/mic/mic.c
  177. +72 −0 ilight_smartdevice/src/function/mic/mic.h
  178. +129 −0 ilight_smartdevice/src/function/scope/scope.c
  179. +53 −0 ilight_smartdevice/src/function/scope/scope.h
  180. +97 −0 ilight_smartdevice/src/main.c
  181. +75 −0 ilight_smartdevice/src/makefile
  182. +423 −0 ilight_smartdevice/src/task.c
  183. +101 −0 ilight_smartdevice/src/task.h
  184. +11 −0 ot_smarthome_multinode/LICENSE
  185. +167 −0 ot_smarthome_multinode/README.md
  186. BIN ot_smarthome_multinode/doc/screenshots/freeboard_ui.png
  187. BIN ot_smarthome_multinode/doc/screenshots/hardware_connection.jpg
  188. BIN ot_smarthome_multinode/doc/screenshots/openthread_smarthome_application.png
  189. BIN ot_smarthome_multinode/doc/screenshots/start_thread_nodes.PNG
  190. +440 −0 ot_smarthome_multinode/src/frontDoor/main.c
  191. +51 −0 ot_smarthome_multinode/src/frontDoor/makefile
  192. +2,633 −0 ot_smarthome_multinode/src/frontDoor/mbedtls-config.h
  193. +600 −0 ot_smarthome_multinode/src/livingRoom/main.c
  194. +51 −0 ot_smarthome_multinode/src/livingRoom/makefile
  195. +2,633 −0 ot_smarthome_multinode/src/livingRoom/mbedtls-config.h
@@ -0,0 +1,53 @@
# Contributing to embARC Applications

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

For general guideline, **see the [embARC Contributing Guide](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/blob/master/.github/CONTRIBUTING.md).**

For how to contribute to embARC application repository, **see the [embARC Application Contributing Guide](CONTRIBUTING_APPLICATIONS.md).**

## embARC Application Directory Structure
If you want to contribute your embARC application to this repository, you need to follow the guideline.
Each embARC application exists in this repository as a folder, such as *aws_iot_smarthome*.
embARC application contains a number of folders and files. Each folder has a specified purpose, such as
sources, documentation, readme, license, etc.

Here take the *asw_iot_smarthome* application as example.

### Source Code
The source code files resides in the *src* folder. For example:
If this application just consists of one application, the structure will look like below.
```
aws_iot_smarthome/src/
aws_iot_smarthome/src/main.c
aws_iot_smarthome/src/makefile
...
```
If this application consists of several standalone applications, such as the *aws_iot_smarthome_multinode*.
The structure will look like below, each application has a subfolder under *src* folder.
```
aws_iot_smarthome_multinode/src/
aws_iot_smarthome_multinode/src/frontDoor/
aws_iot_smarthome_multinode/src/frontDoor/main.c
aws_iot_smarthome_multinode/src/frontDoor/makefile
aws_iot_smarthome_multinode/src/kitken/
aws_iot_smarthome_multinode/src/kitken/main.c
aws_iot_smarthome_multinode/src/kitken/makefile
...
```

### Documentation
All the documentation related to the application resides in the *doc* folder.
Screenshots of the application and application note can be put in this folder.

### Readme
Readme document usually named as *README.md* right in the application folder, such as *asw_iot_smarthome/README.md*.

Readme is used to describe the following sections:
- **Description**: Describe the application usage.
- **Hardware and Software Setup**: Describe what hardware and external peripheral are needed, and also the software needed.
- **User Manual**: Describe how to use this application, application running screenshots and description are welcomed.
- **Note**: Necessary notes of this application.

### License
License file usually named as *LICENSE* right in the application folder, such as *aws_iot_smarthome/LICENSE*.
@@ -0,0 +1,226 @@
# How to Contribute to embARC Applications

embARC users are welcome to make contributions to embARC, including examples, source code (bug fixes and/or new packages), and documentation. This document is intended to help you contribute to embARC Applications quickly.

* [Prerequisites](#prerequisites)
* [Getting Start with Existing Application](#getting-start-with-existing-application)
* [Creating a New Application in embARC](#creating-a-new-application-in-embarc)
* [Developing Your Application Using Git](#developing-your-application-using-git)
* [Committing Your Work](#committing-your-work)
* [Copyright Notice](#copyright-notice)

## Prerequisites

The hardware we used during development is **EM Starter Kit(aka EMSK)**. We need to download and install the following tools:

+ Download and install [**Development Tools**][30].

+ Here we use [GNU Toolchain][31] in **windows** host.
+ For using GNU or other tools in different host, see [Getting Started with embARC OSP][32] for reference.

![gnu_make][0]

+ Download and install [**Digilent Adapt Software**][33], driver for Digilent JTAG-USB cable.

![digilent_adapt][1]

+ Download and install [**Zadig**][34], replacing a driver for **Windows** host.
+ Before you can start using OpenOCD, you have to download WinUSB driver and replace with it one of FTDI drivers for your hardware development system.
+ See [How to Use OpenOCD on Windows][35] for reference.
+ For more information, see [ARC GNU Toolchain Wiki Home][36].

![zadig][2]

Notices: To do that, you have to connect EMSK to PC using JTAG-USB cable. Then click on the *Options* - *List all devices*, and you can find **Digilent USB Device(Interface 0/1)**. Just replacing **Digilent USB Device(Interface 0)** to WinUSB driver, it helps PC to load executable file into EMSK.

You can see **Digilent USB Device** in the Device Manager if the driver has been installed successfully.

![device_manager][3]

+ Get [**embARC OSP**][37] and [**embARC Applications**][38] source code.
+ Get a [Github Account][39]. Download and install [Git][40],and you have to learn how to develop projects using git. See [Git Book][41] for reference.
+ Download the [**embARC OSP**][37] and rename it to *embarc\_osp*.
+ Fork the *embarc\_applications* to your own repo. You will develop the project based on that in your host.

![fork_app_repo][4]

+ Goto the folder `./embarc_osp`. Run the **Git Bash** and type the following commands to clone **embARC Applications** source code to `./embarc_osp/application` folder:

cd embarc_osp
git clone https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_applications.git application

Then, you can see there are serval applications existing in this folder, such as *aws\_iot\_smarthome*, *aws\_iot\_smarthome\_multinode*, etc.

+ See [embARC Applications README][42] for reference.

+ Download and install [**Doxygen**][43] for building embARC document.

Goto the path: `./embarc_osp/doc`, run the **Command Line** and use the following commands to make embARC document.

![document_folder][5]

![doxygen_make][6]

A few minutes later, you can open the *embARC\_Document.html* using browser.

![embarc_document][7]

+ Download and install [**Tera Term**][44].

## Getting Start with Existing Application

We provided some examples and applications in embARC, user can take reference from them.

+ Access to the examples: [source code of embARC examples][45]
+ Access to the applications: [source code of embARC applications][38]

Here we take bootload example using GNU and EMSK 2.2, EM11D for example. Goto the path: `.\embarc_osp\example\baremetal\bootloader`, run the Command Line and type commands for building and running.

![cmd_make][8]

Run the Tera Term:

![tera_term][9]

For more detail information, see [Getting Started with embARC Using GNU on Windows][46] for reference. And see [Getting Started with embARC OSP][47] to learn how to get start with embARC using different toolsets or hosts.

## Creating a New Application in embARC

See the document **Example Usage Guide** - `./embarc_osp/doc/embARC_Document/html/page_example_usage.html` in the *embarc\_osp* for more detail information. It will help you to create a **Hello World** application using ARC GNU quickly.

![example_usage_guide][10]

## Developing Your Application Using Git

1) Make sure you have installed [Git][40],and know how to use it.

2) Goto the folder `./embarc_osp/application`, create a new folder for your own application, like **smart_device**. Please notice that your application projects should be placed under the folder `./embarc_osp/application`, not `./embarc_osp/example`.

3) Copy **example.makefile** and **main.c.tmpl** in `./embarc_osp/example` folder to the newly created **smart_device** folder.
+ Rename example.makefile to **makefile**.
+ Rename main.c.tmpl to **main.c.**
+ Change the configurations in makefile according to your hardware configuration.
+ Modify your main.c.
+ Compile this application on the command line.
+ Run or debug this application.
See the document **Example Usage Guide** in the [embARC OSP documentation][51] for more information.
>>> **Notices:**
>>> All C source code must adhere to [**Linux Kernel Coding Style**][48]. The source-code files in embARC are documented with C-style code comments and Doxygen-based comments. A Doxygen comment example is shown below:
~~~
/**
* \defgroup EMBARC_APP_TMPL embARC Template Example
* \ingroup EMBARC_APPS_TOTAL
* \ingroup EMBARC_APPS_BOARD_EMSK
* \ingroup EMBARC_APPS_BAREMETAL
* \brief embARC Example for template
* \details
* ### Extra Required Tools
* ### Extra Required Peripherals
* ### Design Concept
* ### Usage Manual
* ### Extra Comments
*/
/**
* \file
* \ingroup EMBARC_APP_TMPL
* \brief main source of template example
*/
/**
* \addtogroup EMBARC_APP_TMPL
* @{
*/
/* embARC HAL */
#include "embARC.h"
#include "embARC_debug.h"
/** main entry */
int main(void)
{
EMBARC_PRINTF("Hello embARC from template example\r\n");
return E_SYS;
}
/** @} */
~~~
+ See [Contributing to embARC OSP][49] for more information about Coding-Style, Document-Style and Git Commit Message Guide, etc.

4) Developing your application using [Git][40]. See [Git Book][41] for learning how to use it.

## Committing Your Work

You can contribute your work by submitting **Pull Request** to *embarc\_applications* in github after finishing your project development. Creating a new **Pull Request**:

![new_pull_request][11]

Choose to compare across forks:

![compare_across_forks][12]

Choose compare changes:

![compare_changes][13]

Create the new pull request:

![create_pull_request][14]

## Copyright Notice

Copyright (c) 2017, Synopsys, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1) Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2) Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3) Neither the name of the Synopsys, Inc., nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. NY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

**For complete embARC license information, please refer to the embARC FOSS Notice** [License][50].

[0]: ./img/cmd_make.PNG "gnu_make"
[1]: ./img/digilent_adapt.PNG "digilent_adapt"
[2]: ./img/zadig.PNG "zadig"
[3]: ./img/device_manager.PNG "device_manager"
[4]: ./img/fork_app_repo.PNG "fork_app_repo"
[5]: ./img/document_folder.PNG "document_folder"
[6]: ./img/doxygen_make.PNG "doxygen_make"
[7]: ./img/embarc_document.PNG "embarc_document"
[8]: ./img/cmd_make.PNG "cmd_make"
[9]: ./img/tera_term.PNG "tera_term"
[10]: ./img/example_usage_guide.PNG "example_usage_guide"
[11]: ./img/new_pull_request.PNG "new_pull_request"
[12]: ./img/compare_across_forks.PNG "compare_across_forks"
[13]: ./img/compare_changes.PNG "compare_changes"
[14]: ./img/create_pull_request.PNG "create_pull_request"

[30]: http://embarc.org/tools.html "Development Tools"
[31]: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/releases "GNU Toolchain"
[32]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/wiki/Getting-Started-with-embARC-OSP "Getting Started with embARC OSP"
[33]: http://store.digilentinc.com/digilent-adept-2-download-only/ "Digilent Adapt Software"
[34]: http://zadig.akeo.ie/ "zadig"
[35]: https://github.com/foss-for-synopsys-dwc-arc-processors/arc_gnu_eclipse/wiki/How-to-Use-OpenOCD-on-Windows "How to Use OpenOCD on Windows"
[36]: https://github.com/foss-for-synopsys-dwc-arc-processors/toolchain/wiki "ARC GNU Toolchain Wiki Home"
[37]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp "embARC OSP"
[38]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_applications "embARC Applications"
[39]: https://github.com/ "Github Account"
[40]: https://git-for-windows.github.io/ "Git"
[41]: https://git-scm.com/book/en/v2 "Git Book"
[42]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_applications/blob/master/README.md "embARC Applications README"
[43]: http://www.stack.nl/~dimitri/doxygen/download.html "Doxygen"
[44]: https://zh.osdn.net/projects/ttssh2/ "Tera Term"
[45]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/tree/master/example "source code of embARC examples"
[46]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/wiki/Getting-Started-with-embARC-Using-GNU-on-Windows#building-and-running-your-first-example "Getting Started with embARC Using GNU on Windows"
[47]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/wiki/Getting-Started-with-embARC-OSP "Getting Started with embARC OSP"
[48]: https://github.com/torvalds/linux/blob/master/Documentation/process/coding-style.rst "Linux Kernel Coding Style"
[49]: https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_osp/blob/master/.github/CONTRIBUTING.md "Contributing to embARC OSP"
[50]: http://embarc.org/embarc_osp/doc/embARC_Document/html/page_license.html "License"
[51]: http://embarc.org/embarc_osp/doc "embARC OSP Documentation"
@@ -0,0 +1,40 @@
# Issue Summary
- **Type**: *Bug* | *Enhancement* | *Question*
- **Category**: *Performance* | *Stablity* | *Tools* | *Documentation* | *Installation* | *Usability*
- **Priority**: *Urgent* | *High* | *Medium* | *Low*
- **Release Version**: Specified version such as 2016.05 or All

--------------------------------------------------------------------------------
# Bug

## Development Environment
- **HOST OS**
Input the host os name and its version.
For example, Windows 7, 64Bit | Debian Linux 8.6, 64Bit

- **TOOLCHAIN**
Input the toolchain name and its version.
For example, MWDT L-2016.06 | ARC GNU 2016.03.
You can also put the compiler version here.

- **BOARD**
Input the board name and its version.
For example, EMSK 2.2 | AXS 103 | nSIM

- **ARC CORE**
Input the ARC core name, such as EM7D.

## Bug Description
Describe the bug you met in details, and tell us how to reproduce it.
If you want to put some log information here, you can post it here or in github gist.
If there are some screenshots, you can post outside of github, and provide links here.

--------------------------------------------------------------------------------
# Enhancement
Describe the enhancement you suggest to add in details.
Explain why you want this enhancement to be added, what are the pros and cons?
Do you have any initial implementation about this enhancement, if yes, post link here.

--------------------------------------------------------------------------------
# Question
Input your question in details here.
@@ -0,0 +1,51 @@
---
name: Bug report
about: Create a report to help us improve

---

## Bug Summary
- **Category**: *Performance* | *Stablity* | *Tools* | *Documentation* | *Installation* | *Usability*
- **Priority**: *Urgent* | *High* | *Medium* | *Low*
- **Release Version**: Specified version such as 2017.12 or All
--------------------------------------------------------------------------------

## Development Environment
- **HOST OS**
Input the host os name and its version.
For example, Windows 7, 64Bit | Debian Linux 8.6, 64Bit

- **TOOLCHAIN**
Input the toolchain name and its version.
For example, MWDT L-2016.06 | ARC GNU 2016.03.
You can also put the compiler version here.

- **BOARD**
Input the board name and its version.
For example, EMSK 2.2 | AXS 103 | nSIM

- **ARC CORE**
Input the ARC core name, such as EM7D.

## Bug Description
* Describe the bug you met in details, and tell us how to reproduce it.
* If you want to put some log information here, you can post it here or in github gist.
* If there are some screenshots, you can post outside of github, and provide links here.

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Type '...' on '....'
3. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Additional context**
Add any other context about the problem here.
@@ -0,0 +1,17 @@
---
name: Feature request
about: Suggest an idea for this project

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.

0 comments on commit b6b266c

Please sign in to comment.
You can’t perform that action at this time.