readme: Update README.rst to align with 1.1.0 release #1

mprinn · 2016-08-09T13:45:43Z

Signed-off-by: Malcolm Prinn malcolm.prinn@intel.com

mcomyns · 2016-08-09T14:29:46Z

This is the latest toolchain ? ISSM have not provided one that does not have 'alpha' in it ?

The toolchain is provided from both within the ISSM package or `standalone tarballs https://github.com/01org/qmsi/releases/tag/v1.1.0-alpha

The applications are build in 'release' mode by default - not 'debug'

E.g. to build the hello_world example app (by default it will be built in
debug mode):
make –C examples/hello_world

The naming on the toolchain provided in has changed since the initial one we provided - Can we just have this section the same as in the 'Environment' section (i.e. $HOME/issm_2016/)

You must first flash a bootstrap rom before flashing an application.
Assuming the toolchain was unpacked into $HOME/issm_2016.0.019/, this can be
done with:
$ cd $HOME/issm_2016.0.019/tools/debugger/openocd

This part has insufficient information :
(a) We need to specify to open a new terminal to start gdb
(b) Only D2000 information is provided - we need to provide similar for C1000 ('x86'
and 'sensor' addresses for loading C1000 applications for example.
(c) Path to the ROM/Application file is incorrect - By default it is in the 'release' dir not 'debug' :
$PATH_TO_QMSI/build/release/quark_d2000/rom/quark_d2000_rom.bin
$PATH_TO_QMSI/examples/hello_world/release/quark_d2000/bin/hello_world.bin

$ gdb
(gdb) target remote :3333
(gdb) monitor clk32M 5000
(gdb) monitor load_image $PATH_TO_QMSI/build/debug/quark_d2000/rom/quark_d2000_rom.bin 0x0
(gdb) monitor load_image $PATH_TO_QMSI/examples/hello_world/debug/quark_d2000/bin/hello_world.bin 0x00180000

This will not always be 'USB0'

You can check UART console output with picocom or screen:
$ picocom -b 115200 --imap lfcrlf /dev/ttyUSB0
or
$ screen /dev/ttyUSB0 115200

jeez · 2016-08-09T14:46:07Z

README.rst

 * OpenOCD is required to flash applications and ROM files onto the SoC.
 * GDB is optional, it is used as a supplement to OpenOCD for debugging.
 * `Intel® System Studio for Microcontrollers <https://software.intel.com/en-us/intel-system-studio-microcontrollers>`_ is optional.

-* The toolchain is provided from both within the ISSM package or `standalone tarballs <https://software.intel.com/en-us/articles/issm-toolchain-only-download>`_.
+* The toolchain is provided from both within the ISSM package or `standalone tarballs <https://github.com/01org/qmsi/releases/tag/v1.1.0-alpha>`_.


@mprinn this is wrong. You are removing more up-to-date information.
Please drop this modification and keep the link pointing to the standalone tarball.

mprinn · 2016-08-09T15:13:33Z

updated with associated comments, please check again.

mcomyns · 2016-08-09T15:37:13Z

README.rst

-``(gdb) monitor load_image $PATH_TO_QMSI/examples/hello_world/debug/quark_d2000/bin/hello_world.bin 0x00180000``
+``(gdb) monitor load_image $PATH_TO_QMSI/examples/hello_world/release/quark_d2000/x86/bin/hello_world.bin 0x00180000``
+
+For Quark™ C1000, the following commands are used to flash a ROM and application to the device:


We refer to this as 'Quark SE' in the 'SoC Targets / SoC Core' sections.

There seems to be some differences throughout the doc with reference to 'D2000' 'Quark D2000' 'Quark SE' etc... If we use 'Intel' or 'Quark' in the name then we have to use the FULL branded name ... but 'D2000' 'SE' or 'SE C1000' should be ok.

Can we just use the names with Quark when we first introduce them (i.e. on the SoC Targets section) and then just use SE and D2000 elsewhere @mcomyns ? If yes, what do you think, @mprinn ?

well they are introduced much futher up the line in hardware compatibility, but yes brevity and conformity would be better.

It's more of a trademark and branding issue . You cannot say 'Quark™ C1000' you have to have 'Intel(R) Quark(TM) microcontroller C1000'. We can use 'D2000' or 'SE' or 'SE C1000' for brevity in this doc. You just can't use the 'Intel' or 'Quark' without putting the full name.

in the overview even.

No - they are fine. Anywhere that has the full branded name is ok.

Just in the rest of the doc ... e.g. here we have 'Quark D2000' on one line and 'D2000' on the next. It's not that much of an issue.. just be nice to use the same names consistently

Both Quark D2000 and Quark SE are supported. You can select them by setting the SOC variable.
To build for D2000:

jeez · 2016-08-09T16:40:41Z

Almost there, @mprinn . I believe just one more round and we are done.

mprinn · 2016-08-10T08:45:53Z

Third time's the charm?
Replaced all instances apart from the first one or two with just SE C1000 and D2000.
made sure the ® was after all Intels

mcomyns · 2016-08-10T08:52:30Z

README.rst

 done with:

-``$ cd $HOME/issm_2016.0.019/tools/debugger/openocd``
+``$ cd $HOME/issm_2016/tools/debugger/openocd``

 ``$ ./bin/openocd -f scripts/board/quark_d2000_onboard.cfg``


One last thing :) Can we include the OpenOCD config file for the SE as well --- quark_se_onboard.cfg...

The rest looks fine.

Signed-off-by: Malcolm Prinn <malcolm.prinn@intel.com>

jeez · 2016-08-10T12:00:22Z

README.rst

 * Intel® Quark™ Microcontroller D2000 Development Platform.

 External Dependencies
 *********************

-* The ISSM toolchain (version: 2016-05-12) is required to build the source code. It provides both the IAMCU and the ARCMCU toolchains (i586-intel-elfiamcu and arc-elf32, respectively).


Why did you remove the version from here? The dependencies file does not state the version, it must be added either here or there.

jeez · 2016-08-10T12:10:19Z

@mprinn last round for sure!

mprinn · 2016-08-10T12:42:31Z

i highly doubt that, can you make the changes please

jeez · 2016-08-10T12:56:02Z

no problem, Malcolm. I had to create a new pull request so I could finish it. I'm closing this one.
Thanks for the work: #3

jeez · 2016-08-10T12:57:08Z

@mcomyns can you please review the README file on #3 instead ? It's the same from here with the addition of the ISSM toolchain version supported.

jeez mentioned this pull request Aug 9, 2016

QMSI 1.1.0 Release - Code Drop #2

Merged

jeez reviewed Aug 9, 2016
View reviewed changes

mprinn force-pushed the master branch from 9e999f7 to 1aa3054 Compare August 9, 2016 15:09

mcomyns reviewed Aug 9, 2016
View reviewed changes

mprinn force-pushed the master branch from 1aa3054 to d67c161 Compare August 10, 2016 08:44

mcomyns reviewed Aug 10, 2016
View reviewed changes

readme: Update README.rst to align with 1.1.0 release

08c14a9

Signed-off-by: Malcolm Prinn <malcolm.prinn@intel.com>

mprinn force-pushed the master branch from d67c161 to 08c14a9 Compare August 10, 2016 09:21

jeez reviewed Aug 10, 2016
View reviewed changes

jeez closed this Aug 10, 2016

skiselev mentioned this pull request Dec 28, 2016

Implement a function to configure a GPIO pin independently of other GPIO pins #18

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

readme: Update README.rst to align with 1.1.0 release #1

readme: Update README.rst to align with 1.1.0 release #1

mprinn commented Aug 9, 2016

mcomyns commented Aug 9, 2016

jeez Aug 9, 2016 •

edited

Loading

mprinn commented Aug 9, 2016

mcomyns Aug 9, 2016

jeez Aug 9, 2016

mprinn Aug 10, 2016

mcomyns Aug 10, 2016

mprinn Aug 10, 2016

mcomyns Aug 10, 2016

jeez commented Aug 9, 2016

mprinn commented Aug 10, 2016

mcomyns Aug 10, 2016

jeez Aug 10, 2016

jeez commented Aug 10, 2016

mprinn commented Aug 10, 2016

jeez commented Aug 10, 2016

jeez commented Aug 10, 2016

readme: Update README.rst to align with 1.1.0 release #1

readme: Update README.rst to align with 1.1.0 release #1

Conversation

mprinn commented Aug 9, 2016

mcomyns commented Aug 9, 2016

jeez Aug 9, 2016 • edited Loading

Choose a reason for hiding this comment

mprinn commented Aug 9, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeez commented Aug 9, 2016

mprinn commented Aug 10, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jeez commented Aug 10, 2016

mprinn commented Aug 10, 2016

jeez commented Aug 10, 2016

jeez commented Aug 10, 2016

jeez Aug 9, 2016 •

edited

Loading