Difference between revisions of "Quick Start Guide/Flashing"

From Ethersex_Wiki
Jump to: navigation, search
(→‎AVRDUDE in makefile and menuconfig)
(→‎AVR Fuses)
 
(18 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{i18n|Quick Start Guide/Flashing}}
 
{{i18n|Quick Start Guide/Flashing}}
  
−
= Requirements =
+
= Flashing =
 +
 
 +
After compiling the ''ethersex.hex'' you can flash it with avrdude. You can either use avrdude on the command line or call the target ''program'' from the [[Ethersex]] Makefile.
 +
 
 +
== Prerequisites ==
  
 
* the previously selected board, e.g. AVR NET-IO, ready built and (hopefully) tested
 
* the previously selected board, e.g. AVR NET-IO, ready built and (hopefully) tested
 
* an ISP-Programmer of your choice supported by [http://www.nongnu.org/avrdude avrdude]
 
* an ISP-Programmer of your choice supported by [http://www.nongnu.org/avrdude avrdude]
−
* ISP connector cable
+
* an ISP connector cable that fits to your programmer and your board (either 6 or 10-pin)
 +
* an ethersex.hex compiled in the [[Quick_Start_Guide/Configuration | previous step]]
 +
 
 +
If you have an ISP-Programmer with a 6-pin port and a board with a 10-pin header - like the AVR NET-IO - you can create an adapter. You can see the pin configuration in figure 4-1 at page 5 [http://www.atmel.com/dyn/resources/prod_documents/doc2521.pdf AVR042: AVR Hardware Design Considerations]. Note that Pin 4 of the 10-pin connector is not used on the AVR NET-IO. GND has to be connected to one of the other Pins (6, 8 or 10).
 +
 
 +
== Flashing the image with avrdude ==
  
−
= Flashing with avrdude =
+
The following commands are just examples, the actual command line depends on your ISP-Programmer and hardware.
  
−
Avrdude offers several options. We will look on the most important, to make basic flashing of ethersex possible.
+
This example is for a serial connection (e.g. the ATMEL Evaluation-Board):
  
−
* The chip you use, should be m32 for the ATMega32 in most cases: -p m32
+
  avrdude -v -p m32 -c ponyser -P /dev/ttyS0 -U flash:w:ethersex.hex  
−
* Debug messages: -v
 
−
* The protocol spoken with the programmer, for the Evaluation-Board: -c ponyser
 
−
* The serial port the programmer is connected to: -P /dev/ttyS0  
 
−
* The command you want to execute: -U flash:w:ethersex.hex
 
  
−
After you checked all options and adjusted them to your settings you should have a command like this:
+
This example for a real USB ISP-Programmer:
  
−
   avrdude -v -p m32 -c ponyser -P /dev/ttyS0 -U flash:w:ethersex.hex
+
   avrdude -p m1284p -c avrispmkII -P usb -U flash:w:ethersex.hex
  
−
= Writing the Bytes =
+
For a serial programmer connected via an USB-serial-adapter this may be used:
  
−
* Disconnect the power from the NET-IO
+
  avrdude -v -p m32 -c stk500v2 -P /dev/ttyACM0 -U flash:w:ethersex.hex
−
* Connect your ISP cable to the programmer and the Net-IO
+
 
−
* Reconnect the power and connect your programmer to the PC
+
And this one for a parallel ISP-Cable:
−
* Execute the command you assembled earlier
+
 
−
* Congratulations! If avrdude finished without any error you successfully flashed ethersex to your Net-IO!
+
  avrdude -p m32 -e -c stk200 -U flash:w:ethersex.hex
−
* Disconnect the power and the programmer from the Net-IO
 
−
* Reconnect the power, your Net-IO should boot up with ethersex
 
  
−
----
+
After flashing remove the ISP-Cable and interrupt the power connection for a short time to reboot the board.
  
−
= AVRDUDE in makefile and menuconfig =
+
  * -p m32: ATMega32; -p m644: ATMega644; -p ? to list the valid parts
 +
  * -v: display debug messages
 +
  * -c ponyser: traditional serial programmer; -c stkk500v2 for the Atmel board
 +
  * -P /dev/tty.serial the serial port your programmer is connected to; -P COM1 for windows machines; -P usb for USB
 +
  * -U the command you want to execute. In our case we want to flash: -U flash:w:ethersex.hex
  
−
'''/* PAGE UNDER CONSTRUCTION */'''
+
== Using avrdude from the makefile ==
  
−
Since commit [https://github.com/ethersex/ethersex/commit/16c2a388ec775b51c049db1eeff3a8171c6ad71b 16c2a388ec] the [[Ethersex]] makefile supports two new targets, ''program'' and ''fuses'', to invoke avrdude. The target ''program'' calls avrdude with the options to flash the previously compiled ''ethersex.hex'' to the MCU. The ''fuses'' target may be used to program the MCUs fuse registers.
+
Since [https://github.com/ethersex/ethersex/commit/16c2a388ec775b51c049db1eeff3a8171c6ad71b 16c2a388ec] the [[Ethersex]] makefile supports two new targets, ''program'' and ''fuses'', to invoke avrdude. The target ''program'' calls avrdude with the options to flash the previously compiled ''ethersex.hex'' to the MCU. The ''fuses'' target may be used to program the MCUs fuse registers.
  
−
<!-- REM: Note MCU/Freq settings has to be configured first. -->
+
AVRDUDE options and MCU fuse register settings may be configured via a menuconfig dialog. All settings will be saved to the current profile ''.config''.
  
−
== AVRDUDE Configuration ==
+
Available settings and choices on the AVRDUDE configuration page depend on the MCU and clock frequency configured on the General Setup dialog. Please go back to the [[Quick_Start_Guide/Configuration | previous step]] if you haven't done that yet.
  
−
If - and only if - the avrdude executable could be found in your ''PATH'', menuconfigs mainmenu will show an option to enter AVRDUDE configuration:
+
=== AVRDUDE Configuration ===
  
−
[[File:avrdude_mainmenu.png]]
+
If - and only if - the avrdude executable could be found in your ''PATH'', menuconfig's mainmenu will show an option to enter AVRDUDE configuration.
  
−
[[File:avrdude_menu.png]]
+
[[File:avrdude_mainmenu.png|right|sub|thumb|200px|menuconfig's mainmenu with AVRDUDE Configuration selected]]
  
 
The AVRDUDE configuration page allows to setup the most common options for avrdude:
 
The AVRDUDE configuration page allows to setup the most common options for avrdude:
 +
 +
[[File:avrdude_menu.png|right|sub|thumb|200px|AVRDUDE configuration page]]
  
 
;Programmer Type
 
;Programmer Type
Line 75: Line 84:
 
: Do not use this option if your e6 configuration uses the last four bytes of the eeprom.
 
: Do not use this option if your e6 configuration uses the last four bytes of the eeprom.
 
;Bitclock for ISP or JTAG
 
;Bitclock for ISP or JTAG
 +
:avrdude option '-B'.
 +
:Specify the bit clock period for the JTAG interface or the ISP clock.
 +
:Setting a lower value means higher programming speed. Use higher values if you experience programming errors in your setup.
 +
: 
 +
: The available choices depend on the MCU frequency setting and should not exceed 4/F_CPU in micro seconds:
 +
:
 +
:*4 micro seconds is required for F_CPU < 4 MHz.
 +
:*1 micro second is appropriate for F_CPU < 10 MHz.
 +
:*0.5 micro seconds is appropriate for F_CPU < 16 MHz.
 +
:*0.3 micro seconds is appropriate for F_CPU >= 16 MHz.
 
:
 
:
 
;Pass extra options to avrdude
 
;Pass extra options to avrdude
 +
:If your programmer or setup requires any extra options to avrdude you may pass them here.
 +
 +
=== AVR Fuses ===
 +
 +
The fuse registers enable/disable or control the basic functionality of the different units of the MCU. One can e. g. enable or disable the Watchdog, the JTAG interface or even the ISP Interface. Configuration of the MCUs clock source or the brown-out detector is also done via the fuse registers.
 +
 +
 +
'''[[WARNING:]] Programming wrong fuse values may render your MCU UNUSABLE''' (...unless you've access to a JTAG- and/or HV-Programmer.)
 +
 +
* '''There is nothing like ''the universal correct fuse setting'' or ''default fuse setting''.'''
 +
* '''Fuse registers are MCU-specific and their correct settings heavily depend on the circuit and parts in use.'''
 +
* '''Be careful, read the datasheet for the MCU acually in use and think twice what is correct for YOUR hardware!!'''
 +
* '''Do NOT use generic settings you've found somewhere in the net...'''
 +
 +
 +
;Fuse Low Byte (FLB)
 +
:AVR Fuse Low Byte, two-digit hex value.
 +
:
 +
;Fuse High Byte (FHB)
 +
:AVR Fuse High Byte, two-digit hex value.
 
:
 
:
 +
;Extended Fuse Byte (EFB)
 +
:AVR Extended Fuse Byte, two-digit hex value.
  
−
== AVR Fuses ==
+
The necessary hex values for the fuse registers might be calculated with e.g. an online [http://www.engbedded.com/fusecalc AVR fuse calculator].
 +
 
 +
[http://www.mikrocontroller.net/articles/AVR_Fuses Article on mikrocontroller.net for reference (German).]
 +
 
 +
== Writing the Bytes ==
 +
 
 +
* Disconnect the power from the target board
 +
* Connect your ISP cable to the programmer and the target board
 +
* Reconnect the power and connect your programmer to the PC
 +
* Execute the command you assembled earlier or type ''make program''
 +
* Congratulations! If [[avrdude]] finished without any error you successfully flashed [[Ethersex]] to your target board!
 +
* Disconnect the power and the programmer from the target
 +
* Reconnect the power, your target should boot up with [[Ethersex]]
  
−
BIG FAT WARNING!
+
[[Quick_Start_Guide/Configuration | previous step]]
  
−
[[Quick_Start_Guide/Configuration | previous step]] |
+
[[Category:Ethersex]]
 +
[[Category:Quick Start Guide]]
 +
[[Category:StepByStep]]

Latest revision as of 19:20, 29 August 2014

Language

English – Deutsch – Nederlands – Français – Español – Italiano

Flashing

After compiling the ethersex.hex you can flash it with avrdude. You can either use avrdude on the command line or call the target program from the Ethersex Makefile.

Prerequisites

  • the previously selected board, e.g. AVR NET-IO, ready built and (hopefully) tested
  • an ISP-Programmer of your choice supported by avrdude
  • an ISP connector cable that fits to your programmer and your board (either 6 or 10-pin)
  • an ethersex.hex compiled in the previous step

If you have an ISP-Programmer with a 6-pin port and a board with a 10-pin header - like the AVR NET-IO - you can create an adapter. You can see the pin configuration in figure 4-1 at page 5 AVR042: AVR Hardware Design Considerations. Note that Pin 4 of the 10-pin connector is not used on the AVR NET-IO. GND has to be connected to one of the other Pins (6, 8 or 10).

Flashing the image with avrdude

The following commands are just examples, the actual command line depends on your ISP-Programmer and hardware.

This example is for a serial connection (e.g. the ATMEL Evaluation-Board): 

 avrdude -v -p m32 -c ponyser -P /dev/ttyS0 -U flash:w:ethersex.hex

This example for a real USB ISP-Programmer: 

 avrdude -p m1284p -c avrispmkII -P usb -U flash:w:ethersex.hex

For a serial programmer connected via an USB-serial-adapter this may be used: 

 avrdude -v -p m32 -c stk500v2 -P /dev/ttyACM0 -U flash:w:ethersex.hex

And this one for a parallel ISP-Cable: 

 avrdude -p m32 -e -c stk200 -U flash:w:ethersex.hex

After flashing remove the ISP-Cable and interrupt the power connection for a short time to reboot the board. 

 * -p m32: ATMega32; -p m644: ATMega644; -p ? to list the valid parts
 * -v: display debug messages 
 * -c ponyser: traditional serial programmer; -c stkk500v2 for the Atmel board
 * -P /dev/tty.serial the serial port your programmer is connected to; -P COM1 for windows machines; -P usb for USB
 * -U the command you want to execute. In our case we want to flash: -U flash:w:ethersex.hex

Using avrdude from the makefile

Since 16c2a388ec the Ethersex makefile supports two new targets, program and fuses, to invoke avrdude. The target program calls avrdude with the options to flash the previously compiled ethersex.hex to the MCU. The fuses target may be used to program the MCUs fuse registers.

AVRDUDE options and MCU fuse register settings may be configured via a menuconfig dialog. All settings will be saved to the current profile .config.

Available settings and choices on the AVRDUDE configuration page depend on the MCU and clock frequency configured on the General Setup dialog. Please go back to the previous step if you haven't done that yet.

AVRDUDE Configuration

If - and only if - the avrdude executable could be found in your PATH, menuconfig's mainmenu will show an option to enter AVRDUDE configuration.

menuconfig's mainmenu with AVRDUDE Configuration selected

The AVRDUDE configuration page allows to setup the most common options for avrdude:

AVRDUDE configuration page
Programmer Type
avrdude option '-c'.
Use the programmer configuration choosen from the list.
Refer to the official avrdude documentation if you're in doubt about the correct choice for your programmer (avrdude home).
NB: The list of choices is generated by calling 'avrdude -c ?' and contains all the programmers your avrdude executable supports.
Port
avrdude option '-P'.
Specify the port the programmer is connected to. Serial devices like ponyprog use for example /dev/ttyS0 (= COM1 under Windows!), most modern programmers use usb.
Note that most old-style serial programmers will not work properly when connected to an USB-serial-Adapter!
Extra verbose output
avrdude option '-v -v'.
Be more verbose. Default is '-v'. Use this, if you experience problems while flashing or simply want to see in detail whats going on...
Do NOT verify after programming
avrdude option '-V'.
Do NOT verify flash memory after programming. Use with care and only if you're really sure that your setup is perfect. Speeds things up a bit but it's use is generally discouraged.
Count # of erase cycles in EEPROM
avrdude option '-y'.
Tell avrdude to maintain an erase cycle counter in the last four bytes of the eeprom. The counter has to be initialized by calling avrdude with the option '-Y 1' once.
Do not use this option if your e6 configuration uses the last four bytes of the eeprom.
Bitclock for ISP or JTAG
avrdude option '-B'.
Specify the bit clock period for the JTAG interface or the ISP clock.
Setting a lower value means higher programming speed. Use higher values if you experience programming errors in your setup.
The available choices depend on the MCU frequency setting and should not exceed 4/F_CPU in micro seconds:
  • 4 micro seconds is required for F_CPU < 4 MHz.
  • 1 micro second is appropriate for F_CPU < 10 MHz.
  • 0.5 micro seconds is appropriate for F_CPU < 16 MHz.
  • 0.3 micro seconds is appropriate for F_CPU >= 16 MHz.
Pass extra options to avrdude
If your programmer or setup requires any extra options to avrdude you may pass them here.

AVR Fuses

The fuse registers enable/disable or control the basic functionality of the different units of the MCU. One can e. g. enable or disable the Watchdog, the JTAG interface or even the ISP Interface. Configuration of the MCUs clock source or the brown-out detector is also done via the fuse registers.


WARNING: Programming wrong fuse values may render your MCU UNUSABLE (...unless you've access to a JTAG- and/or HV-Programmer.)

  • There is nothing like the universal correct fuse setting or default fuse setting.
  • Fuse registers are MCU-specific and their correct settings heavily depend on the circuit and parts in use.
  • Be careful, read the datasheet for the MCU acually in use and think twice what is correct for YOUR hardware!!
  • Do NOT use generic settings you've found somewhere in the net...


Fuse Low Byte (FLB)
AVR Fuse Low Byte, two-digit hex value.
Fuse High Byte (FHB)
AVR Fuse High Byte, two-digit hex value.
Extended Fuse Byte (EFB)
AVR Extended Fuse Byte, two-digit hex value.

The necessary hex values for the fuse registers might be calculated with e.g. an online AVR fuse calculator.

Article on mikrocontroller.net for reference (German).

Writing the Bytes

  • Disconnect the power from the target board
  • Connect your ISP cable to the programmer and the target board
  • Reconnect the power and connect your programmer to the PC
  • Execute the command you assembled earlier or type make program
  • Congratulations! If avrdude finished without any error you successfully flashed Ethersex to your target board!
  • Disconnect the power and the programmer from the target
  • Reconnect the power, your target should boot up with Ethersex

previous step

Retrieved from "http://www.ethersex.de/index.php?title=Quick_Start_Guide/Flashing&oldid=1317"