{"action":"created","comment":{"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/comments/180185645","pull_request_review_id":110550602,"id":180185645,"diff_hunk":"@@ -0,0 +1,83 @@\n+.. _shields\n+\n+Shields\n+#######\n+\n+Shields have been introduced on Zephyr as a new element that can be used\n+for easier prototyping.\n+\n+Aim of the shield feature is to provide zephyr formatted shield description\n+for easier compatibility with applications.\n+\n+Shield porting and configuration\n+********************************\n+\n+Shields are available in board directory under :file:`/boards/shields`.\n+Following files are provided for shield configuration:\n+\n+.. code-block:: none\n+\n+   boards/shields/<shield>\n+   ├── Kconfig.shield\n+   ├── Kconfig.defconfig\n+   ├── <shield>.overlay\n+   └── dts.fixup\n+\n+These files provides shield configuration as follows:\n+\n+* **Kconfig.shield**: This file defines the shield's config flag\n+  (CONFIG_SHIELD_X). This flag will be used in an application to trigger the\n+  shield configuration on top of board configuration. Besides in this file,\n+  each driver of shield components (sensors for instance) are enabled.\n+\n+* **Kconfig.defconfig**: This file is used to provide specific driver default\n+  configuration. Since congiruration could be done conditionally it provides\n+  flexibility for broader board support.\n+\n+* **<shield>.overlay**: Device tree overlay is a device tree fragment that","path":"doc/porting/shields.rst","position":37,"original_position":37,"commit_id":"d54a1b94bd56d1e68d731a45d50a455d45b63fa2","original_commit_id":"d54a1b94bd56d1e68d731a45d50a455d45b63fa2","user":{"login":"dbkinder","id":11063618,"avatar_url":"https://avatars0.githubusercontent.com/u/11063618?v=4","gravatar_id":"","url":"https://api.github.com/users/dbkinder","html_url":"https://github.com/dbkinder","followers_url":"https://api.github.com/users/dbkinder/followers","following_url":"https://api.github.com/users/dbkinder/following{/other_user}","gists_url":"https://api.github.com/users/dbkinder/gists{/gist_id}","starred_url":"https://api.github.com/users/dbkinder/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dbkinder/subscriptions","organizations_url":"https://api.github.com/users/dbkinder/orgs","repos_url":"https://api.github.com/users/dbkinder/repos","events_url":"https://api.github.com/users/dbkinder/events{/privacy}","received_events_url":"https://api.github.com/users/dbkinder/received_events","type":"User","site_admin":false},"body":"change to:\r\n\r\n    This file provides a shield description in device tree format that is\r\n    merged with the board's device tree information before compilation.","created_at":"2018-04-09T18:21:23Z","updated_at":"2018-04-09T18:55:25Z","html_url":"https://github.com/zephyrproject-rtos/zephyr/pull/6837#discussion_r180185645","pull_request_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837","author_association":"COLLABORATOR","_links":{"self":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/comments/180185645"},"html":{"href":"https://github.com/zephyrproject-rtos/zephyr/pull/6837#discussion_r180185645"},"pull_request":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837"}}},"pull_request":{"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837","id":178030464,"html_url":"https://github.com/zephyrproject-rtos/zephyr/pull/6837","diff_url":"https://github.com/zephyrproject-rtos/zephyr/pull/6837.diff","patch_url":"https://github.com/zephyrproject-rtos/zephyr/pull/6837.patch","issue_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/6837","number":6837,"state":"open","locked":false,"title":"Enable use of shields","user":{"login":"erwango","id":18574308,"avatar_url":"https://avatars1.githubusercontent.com/u/18574308?v=4","gravatar_id":"","url":"https://api.github.com/users/erwango","html_url":"https://github.com/erwango","followers_url":"https://api.github.com/users/erwango/followers","following_url":"https://api.github.com/users/erwango/following{/other_user}","gists_url":"https://api.github.com/users/erwango/gists{/gist_id}","starred_url":"https://api.github.com/users/erwango/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/erwango/subscriptions","organizations_url":"https://api.github.com/users/erwango/orgs","repos_url":"https://api.github.com/users/erwango/repos","events_url":"https://api.github.com/users/erwango/events{/privacy}","received_events_url":"https://api.github.com/users/erwango/received_events","type":"User","site_admin":false},"body":"This is a first iteration to fulfill https://github.com/zephyrproject-rtos/zephyr/issues/6017: Enable easy use of shields with overlays\r\nIt is currently functional when building sample/sensor/hts221 with board nucleo_f429zi.\r\n\r\nThere are several limitations to overcome:\r\n- Enable use of several shields at a time\r\n- Remove specific board dependency (make it portable across boards)\r\n\r\nAdditionally, final version should provide:\r\n- dedicated sample for the shield\r\n- Add-on to Zephyr Documentation\r\n- This particular shield documentation\r\n\r\nTodo:\r\n- [x] Enable use of over-rinding nodes [1]. Requires upgrade of dtc to V1.4.2\r\n- [x] Enable use of multiple shields\r\n- [x] Complete x-nucleo-iks01a1 porting (including doc)\r\n- [x] Provide x-nucleo-iks01a1 sample\r\n- [x] Update Zephy documentation\r\n- [x] Remove board dependency\r\n\r\n[1] https://git.kernel.org/pub/scm/utils/dtc/dtc.git/commit/?h=v1.4.6&id=3346e065aacb1f05bdfb3872e3ba709b5f895846\r\n\r\n","created_at":"2018-03-28T12:59:54Z","updated_at":"2018-04-09T18:55:26Z","closed_at":null,"merged_at":null,"merge_commit_sha":"c932158a089e28b579d696574dfaab4839b95d1d","assignee":null,"assignees":[],"requested_reviewers":[{"login":"nashif","id":180017,"avatar_url":"https://avatars0.githubusercontent.com/u/180017?v=4","gravatar_id":"","url":"https://api.github.com/users/nashif","html_url":"https://github.com/nashif","followers_url":"https://api.github.com/users/nashif/followers","following_url":"https://api.github.com/users/nashif/following{/other_user}","gists_url":"https://api.github.com/users/nashif/gists{/gist_id}","starred_url":"https://api.github.com/users/nashif/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nashif/subscriptions","organizations_url":"https://api.github.com/users/nashif/orgs","repos_url":"https://api.github.com/users/nashif/repos","events_url":"https://api.github.com/users/nashif/events{/privacy}","received_events_url":"https://api.github.com/users/nashif/received_events","type":"User","site_admin":false},{"login":"SebastianBoe","id":609230,"avatar_url":"https://avatars0.githubusercontent.com/u/609230?v=4","gravatar_id":"","url":"https://api.github.com/users/SebastianBoe","html_url":"https://github.com/SebastianBoe","followers_url":"https://api.github.com/users/SebastianBoe/followers","following_url":"https://api.github.com/users/SebastianBoe/following{/other_user}","gists_url":"https://api.github.com/users/SebastianBoe/gists{/gist_id}","starred_url":"https://api.github.com/users/SebastianBoe/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SebastianBoe/subscriptions","organizations_url":"https://api.github.com/users/SebastianBoe/orgs","repos_url":"https://api.github.com/users/SebastianBoe/repos","events_url":"https://api.github.com/users/SebastianBoe/events{/privacy}","received_events_url":"https://api.github.com/users/SebastianBoe/received_events","type":"User","site_admin":false},{"login":"galak","id":16417047,"avatar_url":"https://avatars2.githubusercontent.com/u/16417047?v=4","gravatar_id":"","url":"https://api.github.com/users/galak","html_url":"https://github.com/galak","followers_url":"https://api.github.com/users/galak/followers","following_url":"https://api.github.com/users/galak/following{/other_user}","gists_url":"https://api.github.com/users/galak/gists{/gist_id}","starred_url":"https://api.github.com/users/galak/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/galak/subscriptions","organizations_url":"https://api.github.com/users/galak/orgs","repos_url":"https://api.github.com/users/galak/repos","events_url":"https://api.github.com/users/galak/events{/privacy}","received_events_url":"https://api.github.com/users/galak/received_events","type":"User","site_admin":false}],"requested_teams":[],"labels":[{"id":724796876,"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/labels/RFC","name":"RFC","color":"d8af5d","default":false},{"id":700753703,"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/labels/area:%20Boards","name":"area: Boards","color":"ededed","default":false},{"id":700909632,"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/labels/area:%20Device%20Tree","name":"area: Device Tree","color":"ededed","default":false}],"milestone":null,"commits_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837/commits","review_comments_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837/comments","review_comment_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/comments{/number}","comments_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/6837/comments","statuses_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/statuses/d54a1b94bd56d1e68d731a45d50a455d45b63fa2","head":{"label":"erwango:dev_shield_overlay","ref":"dev_shield_overlay","sha":"d54a1b94bd56d1e68d731a45d50a455d45b63fa2","user":{"login":"erwango","id":18574308,"avatar_url":"https://avatars1.githubusercontent.com/u/18574308?v=4","gravatar_id":"","url":"https://api.github.com/users/erwango","html_url":"https://github.com/erwango","followers_url":"https://api.github.com/users/erwango/followers","following_url":"https://api.github.com/users/erwango/following{/other_user}","gists_url":"https://api.github.com/users/erwango/gists{/gist_id}","starred_url":"https://api.github.com/users/erwango/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/erwango/subscriptions","organizations_url":"https://api.github.com/users/erwango/orgs","repos_url":"https://api.github.com/users/erwango/repos","events_url":"https://api.github.com/users/erwango/events{/privacy}","received_events_url":"https://api.github.com/users/erwango/received_events","type":"User","site_admin":false},"repo":{"id":76642373,"name":"zephyr","full_name":"erwango/zephyr","owner":{"login":"erwango","id":18574308,"avatar_url":"https://avatars1.githubusercontent.com/u/18574308?v=4","gravatar_id":"","url":"https://api.github.com/users/erwango","html_url":"https://github.com/erwango","followers_url":"https://api.github.com/users/erwango/followers","following_url":"https://api.github.com/users/erwango/following{/other_user}","gists_url":"https://api.github.com/users/erwango/gists{/gist_id}","starred_url":"https://api.github.com/users/erwango/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/erwango/subscriptions","organizations_url":"https://api.github.com/users/erwango/orgs","repos_url":"https://api.github.com/users/erwango/repos","events_url":"https://api.github.com/users/erwango/events{/privacy}","received_events_url":"https://api.github.com/users/erwango/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/erwango/zephyr","description":"Mirror of the zephyr repo on https://gerrit.zephyrproject.org","fork":true,"url":"https://api.github.com/repos/erwango/zephyr","forks_url":"https://api.github.com/repos/erwango/zephyr/forks","keys_url":"https://api.github.com/repos/erwango/zephyr/keys{/key_id}","collaborators_url":"https://api.github.com/repos/erwango/zephyr/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/erwango/zephyr/teams","hooks_url":"https://api.github.com/repos/erwango/zephyr/hooks","issue_events_url":"https://api.github.com/repos/erwango/zephyr/issues/events{/number}","events_url":"https://api.github.com/repos/erwango/zephyr/events","assignees_url":"https://api.github.com/repos/erwango/zephyr/assignees{/user}","branches_url":"https://api.github.com/repos/erwango/zephyr/branches{/branch}","tags_url":"https://api.github.com/repos/erwango/zephyr/tags","blobs_url":"https://api.github.com/repos/erwango/zephyr/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/erwango/zephyr/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/erwango/zephyr/git/refs{/sha}","trees_url":"https://api.github.com/repos/erwango/zephyr/git/trees{/sha}","statuses_url":"https://api.github.com/repos/erwango/zephyr/statuses/{sha}","languages_url":"https://api.github.com/repos/erwango/zephyr/languages","stargazers_url":"https://api.github.com/repos/erwango/zephyr/stargazers","contributors_url":"https://api.github.com/repos/erwango/zephyr/contributors","subscribers_url":"https://api.github.com/repos/erwango/zephyr/subscribers","subscription_url":"https://api.github.com/repos/erwango/zephyr/subscription","commits_url":"https://api.github.com/repos/erwango/zephyr/commits{/sha}","git_commits_url":"https://api.github.com/repos/erwango/zephyr/git/commits{/sha}","comments_url":"https://api.github.com/repos/erwango/zephyr/comments{/number}","issue_comment_url":"https://api.github.com/repos/erwango/zephyr/issues/comments{/number}","contents_url":"https://api.github.com/repos/erwango/zephyr/contents/{+path}","compare_url":"https://api.github.com/repos/erwango/zephyr/compare/{base}...{head}","merges_url":"https://api.github.com/repos/erwango/zephyr/merges","archive_url":"https://api.github.com/repos/erwango/zephyr/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/erwango/zephyr/downloads","issues_url":"https://api.github.com/repos/erwango/zephyr/issues{/number}","pulls_url":"https://api.github.com/repos/erwango/zephyr/pulls{/number}","milestones_url":"https://api.github.com/repos/erwango/zephyr/milestones{/number}","notifications_url":"https://api.github.com/repos/erwango/zephyr/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/erwango/zephyr/labels{/name}","releases_url":"https://api.github.com/repos/erwango/zephyr/releases{/id}","deployments_url":"https://api.github.com/repos/erwango/zephyr/deployments","created_at":"2016-12-16T09:52:08Z","updated_at":"2018-03-28T06:59:31Z","pushed_at":"2018-04-09T16:01:48Z","git_url":"git://github.com/erwango/zephyr.git","ssh_url":"git@github.com:erwango/zephyr.git","clone_url":"https://github.com/erwango/zephyr.git","svn_url":"https://github.com/erwango/zephyr","homepage":null,"size":109387,"stargazers_count":1,"watchers_count":1,"language":"C","has_issues":false,"has_projects":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"archived":false,"open_issues_count":0,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":0,"open_issues":0,"watchers":1,"default_branch":"arm"}},"base":{"label":"zephyrproject-rtos:master","ref":"master","sha":"bdda3695803bcbb61b5947805d5151bdb4299d35","user":{"login":"zephyrproject-rtos","id":19595895,"avatar_url":"https://avatars2.githubusercontent.com/u/19595895?v=4","gravatar_id":"","url":"https://api.github.com/users/zephyrproject-rtos","html_url":"https://github.com/zephyrproject-rtos","followers_url":"https://api.github.com/users/zephyrproject-rtos/followers","following_url":"https://api.github.com/users/zephyrproject-rtos/following{/other_user}","gists_url":"https://api.github.com/users/zephyrproject-rtos/gists{/gist_id}","starred_url":"https://api.github.com/users/zephyrproject-rtos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zephyrproject-rtos/subscriptions","organizations_url":"https://api.github.com/users/zephyrproject-rtos/orgs","repos_url":"https://api.github.com/users/zephyrproject-rtos/repos","events_url":"https://api.github.com/users/zephyrproject-rtos/events{/privacy}","received_events_url":"https://api.github.com/users/zephyrproject-rtos/received_events","type":"Organization","site_admin":false},"repo":{"id":59771425,"name":"zephyr","full_name":"zephyrproject-rtos/zephyr","owner":{"login":"zephyrproject-rtos","id":19595895,"avatar_url":"https://avatars2.githubusercontent.com/u/19595895?v=4","gravatar_id":"","url":"https://api.github.com/users/zephyrproject-rtos","html_url":"https://github.com/zephyrproject-rtos","followers_url":"https://api.github.com/users/zephyrproject-rtos/followers","following_url":"https://api.github.com/users/zephyrproject-rtos/following{/other_user}","gists_url":"https://api.github.com/users/zephyrproject-rtos/gists{/gist_id}","starred_url":"https://api.github.com/users/zephyrproject-rtos/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/zephyrproject-rtos/subscriptions","organizations_url":"https://api.github.com/users/zephyrproject-rtos/orgs","repos_url":"https://api.github.com/users/zephyrproject-rtos/repos","events_url":"https://api.github.com/users/zephyrproject-rtos/events{/privacy}","received_events_url":"https://api.github.com/users/zephyrproject-rtos/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/zephyrproject-rtos/zephyr","description":"Primary GIT Repository for the Zephyr Project","fork":false,"url":"https://api.github.com/repos/zephyrproject-rtos/zephyr","forks_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/forks","keys_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/keys{/key_id}","collaborators_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/teams","hooks_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/hooks","issue_events_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/events{/number}","events_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/events","assignees_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/assignees{/user}","branches_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/branches{/branch}","tags_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/tags","blobs_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/git/refs{/sha}","trees_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/git/trees{/sha}","statuses_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/statuses/{sha}","languages_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/languages","stargazers_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/stargazers","contributors_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/contributors","subscribers_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/subscribers","subscription_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/subscription","commits_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/commits{/sha}","git_commits_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/git/commits{/sha}","comments_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/comments{/number}","issue_comment_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/comments{/number}","contents_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/contents/{+path}","compare_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/compare/{base}...{head}","merges_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/merges","archive_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/downloads","issues_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues{/number}","pulls_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls{/number}","milestones_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/milestones{/number}","notifications_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/labels{/name}","releases_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/releases{/id}","deployments_url":"https://api.github.com/repos/zephyrproject-rtos/zephyr/deployments","created_at":"2016-05-26T17:54:19Z","updated_at":"2018-04-09T17:30:14Z","pushed_at":"2018-04-09T17:56:12Z","git_url":"git://github.com/zephyrproject-rtos/zephyr.git","ssh_url":"git@github.com:zephyrproject-rtos/zephyr.git","clone_url":"https://github.com/zephyrproject-rtos/zephyr.git","svn_url":"https://github.com/zephyrproject-rtos/zephyr","homepage":"https://zephyrproject.org/doc","size":105842,"stargazers_count":755,"watchers_count":755,"language":"C","has_issues":true,"has_projects":true,"has_downloads":true,"has_wiki":true,"has_pages":false,"forks_count":541,"mirror_url":null,"archived":false,"open_issues_count":873,"license":{"key":"apache-2.0","name":"Apache License 2.0","spdx_id":"Apache-2.0","url":"https://api.github.com/licenses/apache-2.0"},"forks":541,"open_issues":873,"watchers":755,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837"},"html":{"href":"https://github.com/zephyrproject-rtos/zephyr/pull/6837"},"issue":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/6837"},"comments":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/issues/6837/comments"},"review_comments":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837/comments"},"review_comment":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/comments{/number}"},"commits":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/pulls/6837/commits"},"statuses":{"href":"https://api.github.com/repos/zephyrproject-rtos/zephyr/statuses/d54a1b94bd56d1e68d731a45d50a455d45b63fa2"}},"author_association":"COLLABORATOR"}}
{"actor":{"display_login":"dbkinder"}}