Photon: Add README file

2017-05-08 13:14:21 -06:00 · 2017-05-08 13:14:21 -06:00 · 13f1ba03d5
commit 13f1ba03d5
parent aa11d637a8
3 changed files with 129 additions and 0 deletions
--- a/Documentation/README.html
+++ b/Documentation/README.html
@ -208,6 +208,8 @@ nuttx/
 |   |   `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/configs/pic32mx7mmb/README.txt" target="_blank"><b><i>README.txt</i></b></a>
 |   |- pic32mz-starterkit/
 |   |   `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/configs/pic32mz-starterkit/README.txt" target="_blank"><b><i>README.txt</i></b></a>
+ |   |- photon/
+ |   |   `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/configs/photon/README.txt" target="_blank"><b><i>README.txt</i></b></a>
 |   |- qemu-i486/
 |   |   `- <a href="https://bitbucket.org/nuttx/nuttx/src/master/configs/qemu-i486/README.txt" target="_blank"><b><i>README.txt</i></b></a>
 |   |- sabre-6quad/
--- a/README.txt
+++ b/README.txt
@ -1580,6 +1580,8 @@ nuttx/
 |   |   `- README.txt
 |   |- pic32mz-starterkit/
 |   |   `- README.txt
+ |   |- photon/
+ |   |   `- README.txt
 |   |- qemu-i486/
 |   |   `- README.txt
 |   |- sabre-6quad/
--- a/configs/photon/README.txt
+++ b/configs/photon/README.txt
@ -0,0 +1,125 @@
+README
+======
+
+  This README discusses issues unique to NuttX configurations for the
+  Particle.io Photon board featuring the STM32F205RG MCU.
+  The STM32F205RG is a 120 MHz Cortex-M3 operation with 1Mbit Flash
+  memory and 128kbytes. The board includes a Broadcom BCM43362 WiFi.
+
+Contents
+========
+
+  - Selecting the Photon board on NuttX
+  - Configuring NuttX to use your Wireless Router (aka Access Point)
+  - Flashing NuttX in the Photon board
+  - Serial console configuration
+
+Selecting the Photon board on NuttX
+===================================
+
+  NOTICE: We will not discuss about toolchains and environment configuration
+  here, please take a look at STM32F4Discory board README or other STM32 board
+  because it should work for Photon board as well.
+
+  Let us to consider that you cloned the nuttx and apps repositories, then
+  follow these steps:
+
+  1) Clear your build system before to start:
+
+     $ make apps_distclean
+     $ make distclean
+
+  2) Enter inside nuttx/tools and configure to use the Photon board:
+
+     $ cd nuttx
+     $ cd tools
+     $ ./configure.sh photon/wlan
+
+  Now please return to root of nuttx/ directory:
+
+    $ cd ..
+
+Configuring NuttX to use your Wireless Router (aka Access Point)
+================================================================
+
+  Since you are already in the root of nuttx/ repository, execute
+  make menuconfig to define your Wireless Router and your password:
+
+  $ make menuconfig
+
+  Browser the menus this way:
+
+  Application Configuration  ---> 
+      NSH Library  --->
+          Networking Configuration  --->
+              WAPI Configuration  --->
+                  (myApSSID) SSID
+                  (mySSIDpassphrase) Passprhase
+
+  Replace the SSID from myApSSID with your wireless router name and
+  the Passprhase with your WiFi password.
+
+  Exit and save your configuration.
+
+  Finally just compile NuttX:
+
+    $ make
+
+Flashing NuttX in the Photon board
+==================================
+
+  Connect the Photon board in your computer using a MicroUSB cable. Press and
+  hold both board's buttons (SETUP and RESET), then release the RESET button,
+  the board will start blinking in the Purple color, waiting until it starts
+  blinking in Yellow color. Now you can release the SETUP button as well.
+
+  1) You can verify if DFU mode in your board is working, using this command:
+
+     $ sudo dfu-util -l
+     dfu-util 0.8
+
+     Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
+     Copyright 2010-2014 Tormod Volden and Stefan Schmidt
+     This program is Free Software and has ABSOLUTELY NO WARRANTY
+     Please report bugs to dfu-util@lists.gnumonks.org
+
+     Found DFU: [2b04:d006] ver=0200, devnum=15, cfg=1, intf=0, alt=1, name="@DCT Flash   /0x00000000/01*016Kg", serial="00000000010C"
+     Found DFU: [2b04:d006] ver=0200, devnum=15, cfg=1, intf=0, alt=0, name="@Internal Flash   /0x08000000/03*016Ka,01*016Kg,01*064Kg,07*128Kg", serial="00000000010C"
+
+  2) Flash the nuttx.bin inside the Internal Flash:
+
+     $ sudo dfu-util -d 2b04:d006 -a 0 -s 0x08020000 -D nuttx.bin
+
+     dfu-util 0.8
+
+     Copyright 2005-2009 Weston Schmidt, Harald Welte and OpenMoko Inc.
+     Copyright 2010-2014 Tormod Volden and Stefan Schmidt
+     This program is Free Software and has ABSOLUTELY NO WARRANTY
+     Please report bugs to dfu-util@lists.gnumonks.org
+
+     dfu-util: Invalid DFU suffix signature
+     dfu-util: A valid DFU suffix will be required in a future dfu-util release!!!
+     Opening DFU capable USB device...
+     ID 2b04:d006
+     Run-time device DFU version 011a
+     Claiming USB DFU Interface...
+     Setting Alternate Setting #0 ...
+     Determining device status: state = dfuIDLE, status = 0
+     dfuIDLE, continuing
+     DFU mode device DFU version 011a
+     Device returned transfer size 4096
+     DfuSe interface name: "Internal Flash   "
+     Downloading to address = 0x08020000, size = 331348
+     Download	[=========================] 100%       331348 bytes
+     Download done.
+     File downloaded successfully
+
+
+Serial console configuration
+============================
+
+  Connect a USB/Serial 3.3V dongle to GND, TX and RX pins of Photon board.
+  Then use some serial console client (minicom, picocom, teraterm, etc) confi-
+  gured to 115200 8n1 without software or hardware flow control.
+
+  Reset the board and you should see NuttX starting in the serial.