Merge branch 'release/v1.2.2'

platformio · Nov 3, 2018 · ce8d519 · ce8d519
2 parents f06751b + 3378290
commit ce8d519
Show file tree

Hide file tree

Showing 17 changed files with 247 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -9,17 +9,32 @@ Lattice iCE40 are the first FPGAs fully usable by open source tools.
 
 # Usage
 
-1. [Install PlatformIO Core](http://docs.platformio.org/page/core.html)
-2. Install Lattice iCE40 development platform:
+1. [Install PlatformIO](http://platformio.org)
+2. Create PlatformIO project and configure a platform option in [platformio.ini](http://docs.platformio.org/page/projectconf.html) file:
 
-```bash
-# install the latest stable version
-> platformio platform install lattice_ice40
+## Stable version
 
-# install development version
-> platformio platform install https://github.com/platformio/platform-lattice_ice40.git
+```ini
+[env:stable]
+platform = lattice_ice40
+board = ...
+...
 ```
 
+## Development version
+
+```ini
+[env:development]
+platform = https://github.com/platformio/platform-lattice_ice40.git
+board = ...
+...
+```
+
+# Configuration
+
+Please navigate to [documentation](http://docs.platformio.org/page/platforms/lattice_ice40.html).
+
+
 # Credits
 
 * [Apio](https://github.com/FPGAwars/apio)

diff --git a/boards/icestick.json b/boards/icestick.json
@@ -10,13 +10,11 @@
       ]
     ],
     "mcu": "iCE40-HX1K-TQ144",
+    "pack": "tq144",
     "size": "1k",
-    "type": "hx",
-    "pack": "tq144"
+    "type": "hx"
   },
-  "frameworks": [
-    "icestorm"
-  ],
+  "frameworks": [],
   "name": "Lattice iCEstick FPGA Evaluation Kit",
   "upload": {
     "maximum_ram_size": 32768,

diff --git a/boards/icezum.json b/boards/icezum.json
@@ -10,13 +10,11 @@
       ]
     ],
     "mcu": "iCE40-HX1K-TQ144",
+    "pack": "tq144",
     "size": "1k",
-    "type": "hx",
-    "pack": "tq144"
+    "type": "hx"
   },
-  "frameworks": [
-    "icestorm"
-  ],
+  "frameworks": [],
   "name": "IceZUM Alhambra FPGA",
   "upload": {
     "maximum_ram_size": 32768,

diff --git a/builder/main.py b/builder/main.py
@@ -24,22 +24,29 @@
 from platform import system
 
 from SCons.Script import (COMMAND_LINE_TARGETS, AlwaysBuild, Builder, Default,
-                          DefaultEnvironment, Environment, Exit, GetOption,
+                          DefaultEnvironment, Exit, GetOption,
                           Glob)
 
 env = DefaultEnvironment()
+pioPlatform = env.PioPlatform()
+
 env.Replace(
     PROGNAME='hardware',
     UPLOADER='iceprog',
     UPLOADERFLAGS=[],
     UPLOADBINCMD='$UPLOADER $UPLOADERFLAGS $SOURCES')
 env.Append(SIMULNAME='simulation')
 
+if "Darwin" == system():
+    env.PrependENVPath(
+        "DYLD_LIBRARY_PATH",
+        join(pioPlatform.get_package_dir('toolchain-icestorm'), "lib")
+    )
+
 # -- Target name for synthesis
 TARGET = join(env['BUILD_DIR'], env['PROGNAME'])
 
 # -- Resources paths
-pioPlatform = env.PioPlatform()
 IVL_PATH = join(
     pioPlatform.get_package_dir('toolchain-iverilog'), 'lib', 'ivl')
 VLIB_PATH = join(
@@ -126,7 +133,7 @@
 # Builder: Arachne-pnr (.blif --> .asc)
 #
 pnr = Builder(
-    action='arachne-pnr -d {0} -P {1} -p {2} -o $TARGET $SOURCE'.format(
+    action='arachne-pnr -d {0} -P {1} -p "{2}" -o $TARGET $SOURCE'.format(
         env.BoardConfig().get('build.size', '1k'),
         env.BoardConfig().get('build.pack', 'tq144'),
         PCF

diff --git a/examples/counter/.gitignore b/examples/counter/.gitignore
@@ -1,3 +1,2 @@
 .pioenvs
-.clang_complete
-.gcc-flags.json
+.piolibdeps
diff --git a/examples/counter/.travis.yml b/examples/counter/.travis.yml
@@ -1,20 +1,20 @@
 # Continuous Integration (CI) is the practice, in software
 # engineering, of merging all developer working copies with a shared mainline
-# several times a day < http://docs.platformio.org/page/ci/index.html >
+# several times a day < https://docs.platformio.org/page/ci/index.html >
 #
 # Documentation:
 #
 # * Travis CI Embedded Builds with PlatformIO
 #   < https://docs.travis-ci.com/user/integration/platformio/ >
 #
 # * PlatformIO integration with Travis CI
-#   < http://docs.platformio.org/page/ci/travis.html >
+#   < https://docs.platformio.org/page/ci/travis.html >
 #
 # * User Guide for `platformio ci` command
-#   < http://docs.platformio.org/page/userguide/cmd_ci.html >
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
 #
 #
-# Please choice one of the following templates (proposed below) and uncomment
+# Please choose one of the following templates (proposed below) and uncomment
 # it (remove "# " before each line) or use own configuration according to the
 # Travis CI documentation (see above).
 #
@@ -35,13 +35,14 @@
 #
 # install:
 #     - pip install -U platformio
+#     - platformio update
 #
 # script:
 #     - platformio run
 
 
 #
-# Template #2: The project is intended to by used as a library with examples
+# Template #2: The project is intended to be used as a library with examples.
 #
 
 # language: python
@@ -60,6 +61,7 @@
 #
 # install:
 #     - pip install -U platformio
+#     - platformio update
 #
 # script:
 #     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N
diff --git a/examples/counter/include/README b/examples/counter/include/README
@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html
diff --git a/examples/counter/lib/README b/examples/counter/lib/README
@@ -0,0 +1,46 @@
+
+This directory is intended for project specific (private) libraries.
+PlatformIO will compile them to static libraries and link into executable file.
+
+The source code of each library should be placed in a an own separate directory
+("lib/your_library_name/[here are source files]").
+
+For example, see a structure of the following two libraries `Foo` and `Bar`:
+
+|--lib
+|  |
+|  |--Bar
+|  |  |--docs
+|  |  |--examples
+|  |  |--src
+|  |     |- Bar.c
+|  |     |- Bar.h
+|  |  |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html
+|  |
+|  |--Foo
+|  |  |- Foo.c
+|  |  |- Foo.h
+|  |
+|  |- README --> THIS FILE
+|
+|- platformio.ini
+|--src
+   |- main.c
+
+and a contents of `src/main.c`:
+```
+#include <Foo.h>
+#include <Bar.h>
+
+int main (void)
+{
+  ...
+}
+
+```
+
+PlatformIO Library Dependency Finder will find automatically dependent
+libraries scanning project source files.
+
+More information about PlatformIO Library Dependency Finder
+- https://docs.platformio.org/page/librarymanager/ldf.html
diff --git a/examples/counter/lib/readme.txt b/examples/counter/lib/readme.txt
diff --git a/examples/counter/test/README b/examples/counter/test/README
@@ -0,0 +1,11 @@
+
+This directory is intended for PIO Unit Testing and project tests.
+
+Unit Testing is a software testing method by which individual units of
+source code, sets of one or more MCU program modules together with associated
+control data, usage procedures, and operating procedures, are tested to
+determine whether they are fit for use. Unit testing finds problems early
+in the development cycle.
+
+More information about PIO Unit Testing:
+- https://docs.platformio.org/page/plus/unit-testing.html
diff --git a/examples/leds/.gitignore b/examples/leds/.gitignore
@@ -1,3 +1,2 @@
 .pioenvs
-.clang_complete
-.gcc-flags.json
+.piolibdeps
diff --git a/examples/leds/.travis.yml b/examples/leds/.travis.yml
@@ -1,17 +1,17 @@
 # Continuous Integration (CI) is the practice, in software
 # engineering, of merging all developer working copies with a shared mainline
-# several times a day < http://docs.platformio.org/page/ci/index.html >
+# several times a day < https://docs.platformio.org/page/ci/index.html >
 #
 # Documentation:
 #
 # * Travis CI Embedded Builds with PlatformIO
 #   < https://docs.travis-ci.com/user/integration/platformio/ >
 #
 # * PlatformIO integration with Travis CI
-#   < http://docs.platformio.org/page/ci/travis.html >
+#   < https://docs.platformio.org/page/ci/travis.html >
 #
 # * User Guide for `platformio ci` command
-#   < http://docs.platformio.org/page/userguide/cmd_ci.html >
+#   < https://docs.platformio.org/page/userguide/cmd_ci.html >
 #
 #
 # Please choose one of the following templates (proposed below) and uncomment
@@ -35,13 +35,14 @@
 #
 # install:
 #     - pip install -U platformio
+#     - platformio update
 #
 # script:
 #     - platformio run
 
 
 #
-# Template #2: The project is intended to by used as a library with examples
+# Template #2: The project is intended to be used as a library with examples.
 #
 
 # language: python
@@ -60,6 +61,7 @@
 #
 # install:
 #     - pip install -U platformio
+#     - platformio update
 #
 # script:
 #     - platformio ci --lib="." --board=ID_1 --board=ID_2 --board=ID_N
diff --git a/examples/leds/include/README b/examples/leds/include/README
@@ -0,0 +1,39 @@
+
+This directory is intended for project header files.
+
+A header file is a file containing C declarations and macro definitions
+to be shared between several project source files. You request the use of a
+header file in your project source file (C, C++, etc) located in `src` folder
+by including it, with the C preprocessing directive `#include'.
+
+```src/main.c
+
+#include "header.h"
+
+int main (void)
+{
+ ...
+}
+```
+
+Including a header file produces the same results as copying the header file
+into each source file that needs it. Such copying would be time-consuming
+and error-prone. With a header file, the related declarations appear
+in only one place. If they need to be changed, they can be changed in one
+place, and programs that include the header file will automatically use the
+new version when next recompiled. The header file eliminates the labor of
+finding and changing all the copies as well as the risk that a failure to
+find one copy will result in inconsistencies within a program.
+
+In C, the usual convention is to give header files names that end with `.h'.
+It is most portable to use only letters, digits, dashes, and underscores in
+header file names, and at most one dot.
+
+Read more about using header files in official GCC documentation:
+
+* Include Syntax
+* Include Operation
+* Once-Only Headers
+* Computed Includes
+
+https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html