Difference between revisions of "DsPIC30F 5011 Development Board"

From OpenCircuits
Jump to navigation Jump to search
m (→‎Java Environment Setup: for linux(ubunut) platform as well)
m (Reverted edits by ColeenRosales (Talk) to last revision by Russ hensel)
 
(43 intermediate revisions by 10 users not shown)
Line 1: Line 1:
 +
This project aims to provide the development tools for building a [[Multi-purpose_Embedded_System | multi-purpose MCU board]]. Description is based on Microchip dsPic33FJ256GP506 (was dsPic30F5011), but information provided in this wiki may give useful directions for developing similar embedded systems with different platforms.
 +
 
==Introduction==
 
==Introduction==
  
===Features of dsPIC30F5011===
+
===Features of dsPic33FJ256GP506===
*2.5 to 5V
+
*3.0 to 3.3 V
*Up to 30MIPs
+
*Up to 40 MIPs
*High current/sink source I/O pins: 25mA
+
*Maximum current sink/source for I/O pins: 4 mA
 +
*16-bit arithmetics
 
*DSP Instruction Set
 
*DSP Instruction Set
 
*Dual programming techniques: ICSP and RTSP
 
*Dual programming techniques: ICSP and RTSP
*UART: up to 2 modules
+
*Memory
*I<sup>2</sup>C: up to 1Mbps
+
**256&nbsp;KB flash (86K instructions)
 +
**16&nbsp;KB RAM (incl. 2&nbsp;KB DMA RAM)
 +
**No EEPROM
 +
*Communications ports
 +
**UART
 +
**I<sup>2</sup>C: up to 1&nbsp;Mbit/s
 +
**SPI
 +
*ADC
 
*10-bit A/D, 1.1 Msps
 
*10-bit A/D, 1.1 Msps
*12-bit A/D, 200 ksps
+
*12-bit A/D, 500 ksps
*44K flash (66Kb), 4Kb RAM, 1Kb EEPROM
+
*No DAC (PWMs only)
*No DAC
 
 
*Pin-to-pin compatible with other dsPICs
 
*Pin-to-pin compatible with other dsPICs
 
{| border="1" cellspacing="0" cellpadding="5"
 
{| border="1" cellspacing="0" cellpadding="5"
|+ Table 1.1 Comparison with Compatible dsPICs
+
|+ Comparison between different dsPICs
! dsPic !! Price<br>US$ !! MIPs
+
! dsPic !! *Price<br>US$ !! MIPs
 
! Flash<br>(kB)!! RAM<br>(kB) !! EEPROM<br>(kB)
 
! Flash<br>(kB)!! RAM<br>(kB) !! EEPROM<br>(kB)
 
! I/O !! ADC<br>12-bit !! IC !! OC !! Motor<br>Ctrl !! Timers
 
! I/O !! ADC<br>12-bit !! IC !! OC !! Motor<br>Ctrl !! Timers
 
! QEI !! UART !! SPI !! I2C !! CAN !! Codec
 
! QEI !! UART !! SPI !! I2C !! CAN !! Codec
|-
 
| 30F5011 || 5.91 || 30
 
| 66 || 4 || 1
 
| 52 || 16 || 8 || 8 || 0 || 5x16bit<br>2x32bit
 
| 0 || 2 || 2 || 1 || 2 || 1
 
 
|-
 
|-
| 30F6011A || 7.73 || 30
+
| 33FJ256GP506 || 6.11 || 40
| 132 || 6 || 2
+
| 256 || 16 || 0
| 52 || 16 || 8 || 8 || 0 || 5x16bit<br>2x32bit
+
| 53 || 18 || 8 || 8 || 0 || 9x16bit<br>4x32bit
| 0 || 2 || 2 || 1 || 2 || 0
+
| 0 || 2 || 2 || 2 || 1 || 1
|-
 
| 30F6012A || 7.85 || 30
 
| 144 || 8 || 4
 
| 52 || 16 || 8 || 8 || 0 || 5x16bit<br>2x32bit
 
| 0 || 2 || 2 || 1 || 2 || 1
 
 
|-  
 
|-  
 
| 33FJ128GP206 || 4.62 || 40
 
| 33FJ128GP206 || 4.62 || 40
Line 60: Line 59:
 
| 53 || 16 || 8 || 8 || 8 || 9x16bit<br>4x32bit
 
| 53 || 16 || 8 || 8 || 8 || 9x16bit<br>4x32bit
 
| 1 || 2 || 2 || 2 || 1 || 0
 
| 1 || 2 || 2 || 2 || 1 || 0
|-
 
| 33FJ256GP506 || 6.11 || 40
 
| 256 || 16 || 0
 
| 53 || 18 || 8 || 8 || 0 || 9x16bit<br>4x32bit
 
| 0 || 2 || 2 || 2 || 1 || 1
 
 
|-
 
|-
 
|}
 
|}
+
<nowiki>*</nowiki>For reference only, subject to change
===Web Page===
 
*[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=2529&param=en024856 Microchip Official Website]
 
  
===Forum===
+
===Forums===
*[http://direct.forum.microchip.com/default.aspx Microchip]: Official forum by Microchip
+
*[http://forum.microchip.com/ Microchip]: Official forum by Microchip
**[http://direct.forum.microchip.com/tt.aspx?forumid=49 MPLAB ICD 2]: Subforum on ICD 2 programmer
+
**See MPLAB ICD 2, MPLAB IDE, MPLAB C30 Compiler, ASM30, Link30 forum, dsPIC30F Topics, dsPic33 topics
**[http://direct.forum.microchip.com/tt.aspx?forumid=57 MPLAB IDE]: Subforum on IDE
 
**[http://direct.forum.microchip.com/tt.aspx?forumid=101 MPLAB C30 Compiler, ASM30, Link30 forum]: Subforum on C compiler. Refer to [http://ww1.microchip.com/downloads/en/DeviceDoc/C30_Users_Guide_51284e.pdf MPLAB C30 C Compiler User's Guide] Chapter 3
 
**[http://direct.forum.microchip.com/tt.aspx?forumid=153 dsPIC30F Topics]: Subformum on dsPIC30F
 
*[http://www.gnupic.org/ GNUPIC]: Discussion on PIC in Linux Systems
 
**[http://www.linuxhacker.org/cgi-bin/ezmlm-cgi?1:dds:5443#b Debian]
 
 
*[http://www.htsoft.com/forum/all/ubbthreads.php/Cat/0/C/6 HI-TECH Software Forum]: Discussion on dsPICC, a C compiler developed by HI-TECH
 
*[http://www.htsoft.com/forum/all/ubbthreads.php/Cat/0/C/6 HI-TECH Software Forum]: Discussion on dsPICC, a C compiler developed by HI-TECH
*[http://piclist.com/techref/piclist/index.htm PICList]: Discussion on older PIC systems (not dsPIC)
+
*[http://sourceforge.net/forum/forum.php?forum_id=382005 FreeRTOS Real Time Kernel]: Open Discussion and Support on FreeRTOS
*[http://groups.google.com/group/pickit-devel PicKit]: Discussion on PICkit/PICkit 2 programmers
+
*[http://www.nabble.com/MicroControllers---GNUPIC-f2057.html Nabble]: MicroControllers - GNUPIC
*[http://sourceforge.net/forum/forum.php?forum_id=382005 FreeRTOS Real Time Kernel]: Open Discussion and Support on FreeRTOS
 
  
 
===References===
 
===References===
*dsPIC30F
 
**[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=2574 dsPIC30F Family Reference Manual Sections]: Contains detailed descriptions on dsPIC30F register definitions and example codes
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80169E.pdf dsPIC30F Family Reference Manual Errata (Use with revision 70046B only)]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70116F.pdf dsPIC30F5011, dsPIC30F5013 Data Sheet]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80210e.pdf dsPIC30F5011/5013 Rev. A1/A2 Silicon Errata]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80223D.pdf dsPIC30F5011/5013 Rev. A3 Silicon Errata]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70102G.pdf Flash Programming Specification]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70157B.pdf dsPIC30F Programmer's Reference Manual]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80170a.pdf dsPIC30F Programmer's Reference Manual Errata (use with revision DS70030E only)]
 
 
 
*dsPIC33F
 
*dsPIC33F
 
**[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=2573 dsPIC33F Family Reference Manual Sections]
 
**[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=2573 dsPIC33F Family Reference Manual Sections]
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70165E.pdf dsPIC33F Family Data Sheet]
+
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70286C.pdf dsPIC33FJXXXGPX06/X08/X10 Data Sheet]
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80279B.pdf dsPIC33F Rev. A2 Silicon Errata]
+
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80306E.pdf dsPIC33FJXXXGPX06/X08/X10 Rev. A2/A3/A4 Silicon Errata]
**[http://ww1.microchip.com/downloads/en/DeviceDoc/80306A.pdf dsPIC33FJXXXGPX06/X08/X10 Rev. A2 Silicon Errata]
+
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70152G.pdf Flash Programming Specification]
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70152C.pdf Flash Programming Specification]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/70172A.pdf dsPIC30F to dsPIC33F Conversion Guidelines]
 
 
*ICD2 Programmer
 
*ICD2 Programmer
**[http://ww1.microchip.com/downloads/en/DeviceDoc/51331B.pdf ICD2 User's Guide]
+
**[http://ww1.microchip.com/downloads/en/DeviceDoc/51331C.pdf ICD2 User's Guide]
 
*MPLAB
 
*MPLAB
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/51519B.pdf MPLAB IDE User's Guide]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/51519B.pdf MPLAB IDE User's Guide]
Line 110: Line 84:
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/16bit_Language_Tool_Libraries_51456c.pdf 16-bit Language Tools Libraries]: Contains summaries and examples of using DSP libraries, standard C libraries and device libraries
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/16bit_Language_Tool_Libraries_51456c.pdf 16-bit Language Tools Libraries]: Contains summaries and examples of using DSP libraries, standard C libraries and device libraries
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/Asm30_Link_Util_51317e.pdf MPLAB ASM30, MPLAB LINK30 and Utilities User's Guide]
 
**[http://ww1.microchip.com/downloads/en/DeviceDoc/Asm30_Link_Util_51317e.pdf MPLAB ASM30, MPLAB LINK30 and Utilities User's Guide]
**[http://ww1.microchip.com/downloads/en/DeviceDoc/51322d.pdf dsPIC30F Language Tools Quick Reference Card]
 
  
 
===Code Examples===
 
===Code Examples===
 
*[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1408 Microchip Example Codes for dsPic]
 
*[http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1408 Microchip Example Codes for dsPic]
 +
 +
===Related Development===
 +
*[[Ethernet Module]]
 +
*[[Modulation Plugin]]
  
  
Line 127: Line 104:
 
**Required low-level programming to erase, program and verify the chip.
 
**Required low-level programming to erase, program and verify the chip.
 
**Slower, because codes are serially executed.
 
**Slower, because codes are serially executed.
**Program memory can be erased using ''Normal-Voltage'' (4.5 – 5.5V) or ''Low-Voltage'' (2.5V – 4.5V).
 
  
 
*Enhanced ICSP
 
*Enhanced ICSP
Line 138: Line 114:
 
====Hardware Interface====
 
====Hardware Interface====
 
{| border="1" cellspacing="0" cellpadding="5"
 
{| border="1" cellspacing="0" cellpadding="5"
|+ Table 2.1 Pin Used by ICSP
+
|+ Pin Used by ICSP
 
! Pin Label !! Function !! Pin Number
 
! Pin Label !! Function !! Pin Number
 
|-  
 
|-  
Line 155: Line 131:
  
 
{| border="1" cellspacing="0" cellpadding="5"
 
{| border="1" cellspacing="0" cellpadding="5"
|+ Table 2.2 Available Programmers in the Market
+
|+ Available Programmers in the Market
 
! Product Name
 
! Product Name
 
! Interface with PC
 
! Interface with PC
 
! Interface with Device
 
! Interface with Device
! Price (US)
+
! *Price (US)
! Postage (US)
+
! Remarks
! Total (US)
 
 
|-  
 
|-  
 
| [http://direct.www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1406&dDocName=en010046&part=DV164005 MPLAB<sup>®</sup> ICD 2]
 
| [http://direct.www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1406&dDocName=en010046&part=DV164005 MPLAB<sup>®</sup> ICD 2]
Line 167: Line 142:
 
| [http://www.microchip.com/Microchip.WWW.SecureSoftwareList/secsoftwaredownload.aspx?device=en010046&lang=en&ReturnURL=http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1406&dDocName=en010046&part=DV164005# 6-PIN RJ-12 connector]
 
| [http://www.microchip.com/Microchip.WWW.SecureSoftwareList/secsoftwaredownload.aspx?device=en010046&lang=en&ReturnURL=http://www.microchip.com/stellent/idcplg?IdcService=SS_GET_PAGE&nodeId=1406&dDocName=en010046&part=DV164005# 6-PIN RJ-12 connector]
 
| $159.99
 
| $159.99
| -
 
 
| -
 
| -
 
|-
 
|-
| [http://www.etekronics.com/product_info.php?cPath=24&products_id=48  Full Speed USB Microchip ICD2<br> Debugger and Programmer]
+
| [http://www.sureelectronics.net Clone Microchip ICD2] (Now Using)
| USB
 
| 6-PIN ICSP connector<br>6-PIN RJ-12 connector
 
| $72.00
 
| $12.00
 
| $84.00
 
|-
 
| [http://www.etekronics.com/product_info.php?cPath=24&products_id=47 Mini Microchip Compatible ICD2<br> Debugger and Programmer]
 
| RS232
 
| 6-PIN ICSP connector<br>6-PIN RJ-12 connector
 
| $45.00
 
| $10.00
 
| $55.00
 
|-
 
| [http://www.inexglobal.com/microcontroller.php ICDX30]
 
| RS232
 
| 6-pin RJ-11
 
| $51.00
 
| $47.46
 
| $98.46
 
|-
 
| *[http://www.sure-electronics.net Clone Microchip ICD2] (Now Using)
 
 
| USB
 
| USB
 
| 6-pin flat cables
 
| 6-pin flat cables
| $30.00
+
| $52.35
| $12.00
+
| Do not work with new MPLAB versions (works for 7.50), communication to MPLAB may sometime hang (see [http://www.sureelectronics.net/pdfs/DB-DP003.pdf manual])
| $42.00
 
 
|-
 
|-
 
|}
 
|}
 +
<nowiki>*</nowiki>For reference only (exclude shipping), subject to change
  
  
 
{| border="1" cellspacing="0" cellpadding="5"
 
{| border="1" cellspacing="0" cellpadding="5"
|+ Table 2.3 DIY ICD 2 Programmer Circuit
+
|+ DIY ICD 2 Programmer Circuit
 
! Source !! Schematic !! PIC16F877A Bootloader
 
! Source !! Schematic !! PIC16F877A Bootloader
 
|-  
 
|-  
Line 214: Line 167:
 
|-
 
|-
 
|}
 
|}
 +
  
 
====Software Interface====
 
====Software Interface====
 
*The program can be written and compiled in an Integrated Development Environment (IDE) using either Assembly or C. The complied codes are then loaded to the device through the external programmer.
 
*The program can be written and compiled in an Integrated Development Environment (IDE) using either Assembly or C. The complied codes are then loaded to the device through the external programmer.
 
  
 
{| border="1" cellspacing="0" cellpadding="5"
 
{| border="1" cellspacing="0" cellpadding="5"
|+ Table 2.4 Summary of IDE
+
|+ Summary of IDE
 
! Product Name !! Features !! OS !! Price (US$)
 
! Product Name !! Features !! OS !! Price (US$)
 
|-  
 
|-  
Line 233: Line 186:
 
| $895.00 (Free student version<sup>1</sup>)
 
| $895.00 (Free student version<sup>1</sup>)
 
|-
 
|-
| [http://linux.softpedia.com/get/Science-and-Engineering/Electronic-Design-Automation-EDA-/Piklab-8099.shtml Piklab 0.12.0]
+
| [http://piklab.sourceforge.net/ Piklab]
 
| Assembler and C-Compiler
 
| Assembler and C-Compiler
 
| Linux
 
| Linux
| Free<sup>2</sup>
+
| Free
 
|}
 
|}
 
# Full-featured for the first 60 days. After 60 days, some code optimization functions are disabled. The compiler will continue to function after 60 days, but code size may increase.
 
# Full-featured for the first 60 days. After 60 days, some code optimization functions are disabled. The compiler will continue to function after 60 days, but code size may increase.
# The current version supports external programmer ICD 2, but not yet tested.
 
  
 
===RTSP: COM Port (Bootloader)===
 
===RTSP: COM Port (Bootloader)===
 
*RTSP works in normal voltage (MCLR# no need to raise to V<sub>IHH</sub>).
 
*RTSP works in normal voltage (MCLR# no need to raise to V<sub>IHH</sub>).
 
*No literature has mentioned the incorporation of Programming Executive (PE). Presumably, since Enhanced ICSP needs to set MCLR# to V<sub>IHH</sub>, RTSP cannot use PE.
 
*No literature has mentioned the incorporation of Programming Executive (PE). Presumably, since Enhanced ICSP needs to set MCLR# to V<sub>IHH</sub>, RTSP cannot use PE.
*Refer to [http://www.opencircuits.com/DsPIC30F_5011_Development_Board#Bootloader_Development bootloader section].
+
*Refer to [[DsPIC30F_5011_Development_Board#Bootloader_Development | bootloader section]].
 
 
 
 
==IC Requirements==
 
{|border="1" cellspacing="0" cellpadding="5"
 
|+ Table 3.1 IC Requirements
 
! Part No. !! Description
 
! Min Temp !! Max Temp !! Min Volt !! Max Volt !! Typ Cur !! Max Cur
 
|-valign="top"
 
| [http://ww1.microchip.com/downloads/en/DeviceDoc/70116F.pdf dsPIC30F5011-30I/PT] || uP
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 2.5V <sup>[1]</sup>|| 5.5V
 
|  145mA  || 217mA
 
|-
 
| [http://datasheets.maxim-ic.com/en/ds/MAX3222-MAX3241.pdf MAX3232ESE] || RS232 driver
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 3.0V || 5.5V
 
| 0.3mA || 1.0mA
 
|-
 
| [http://www.national.com/ds.cgi/DS/DS3695.pdf DS3695N] || RS485 driver
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 4.75V || 5.25V
 
| 42mA || 60mA
 
|-
 
| [http://focus.ti.com/lit/ds/symlink/dac6574.pdf DAC6574IDGS] || 10-bit Quad-DAC I<sup>2</sup>C
 
| -40<sup>o</sup>C || 105<sup>o</sup>C
 
| 2.7V || 5.5V
 
| 0.6mA || 0.9mA
 
|-
 
| [http://www.semiconductors.philips.com/acrobat/datasheets/74HC_HCT14_3.pdf 74HC14D] || Quad-Schmitt Trigger
 
| -40<sup>o</sup>C || 125<sup>o</sup>C
 
| 2.0V || 6.0V
 
| || 0.02mA
 
|-
 
| '''Overall''' ||
 
| '''-40<sup>o</sup>C''' || '''85<sup>o</sup>C'''
 
| '''4.75V''' || '''5.25V'''
 
| || '''<300mA <sup>[2]</sup>'''
 
|-
 
| [http://ww1.microchip.com/downloads/en/DeviceDoc/70165E.pdf dsPIC33FJ128GP306-I/PT] || uP
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 3.0V <sup>[1]</sup>|| 3.6V
 
| 74mA  || 250mA
 
|-
 
| [http://www.analog.com/UploadedFiles/Data_Sheets/ADM3485E.pdf ADM3485EARZ] || RS485 driver
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 3.0V || 3.6V
 
| 1.1mA || 2.2mA
 
|-
 
| [http://ww1.microchip.com/downloads/en/DeviceDoc/21203N.pdf 24LC256-I/SN] || 256kBits I2C EEPROM
 
| -40<sup>o</sup>C || 85<sup>o</sup>C
 
| 2.5V || 5.5V
 
| 400uA || 3mA
 
|-
 
| [http://www.national.com/ds.cgi/LM/LM3940.pdf LM3940IMP-3.3] || 5V-3.3V Regulator
 
| -40<sup>o</sup>C || 125<sup>o</sup>C
 
| 5.0V || 7.5V
 
| 10mA || 250mA
 
|-
 
|}
 
#Minimum voltage measured is 3.3V (with 2 LEDs blinking) running at 30MHz.
 
#Measured current at 5V is 180mA (with 2 LEDs blinking only)
 
  
  
Line 322: Line 213:
  
 
*Microchip has integrated ASM30, LINK30, assembly header files, linker scripts in MPLAB IDE, which is free for download.
 
*Microchip has integrated ASM30, LINK30, assembly header files, linker scripts in MPLAB IDE, which is free for download.
*MPLAB C30 costs US$895. A 60-day free student version is also available. After 60-days, the optimizer is automatically disabled, while other tools can still function properly. Refer to Table 2.4.
+
*MPLAB C30 costs US$895. A 60-day free student version is also available. After 60-days, the optimizer is automatically disabled, while other tools can still function properly.
  
 
*C-libraries contained in C30 includes (Refer to [http://ww1.microchip.com/downloads/en/DeviceDoc/16bit_Language_Tool_Libraries_51456c.pdf 16-Bit Language Tools Libraries] from Microchip).
 
*C-libraries contained in C30 includes (Refer to [http://ww1.microchip.com/downloads/en/DeviceDoc/16bit_Language_Tool_Libraries_51456c.pdf 16-Bit Language Tools Libraries] from Microchip).
Line 328: Line 219:
  
 
{|border="1" cellspacing="0" cellpadding="5"
 
{|border="1" cellspacing="0" cellpadding="5"
|+ Table 4.1 C Libraries in MPLAB C30
+
|+ C Libraries in MPLAB C30
 
! Library !! Directory <br>(\\Microchip\MPLAB C30) !! Major functions
 
! Library !! Directory <br>(\\Microchip\MPLAB C30) !! Major functions
 
|-valign="top"
 
|-valign="top"
Line 335: Line 226:
 
| Vector, Matrix, Filter, etc.
 
| Vector, Matrix, Filter, etc.
 
|-valign="top"
 
|-valign="top"
| 16-Bit Peripheral Libraries <br>(e.g. libp30F5011-coff.a)
+
| 16-Bit Peripheral Libraries
 
| \lib <br> \src\peripheral <br> \support\h
 
| \lib <br> \src\peripheral <br> \support\h
 
| ADC12, IOPort, UART, I<sup>2</sup>C, etc.
 
| ADC12, IOPort, UART, I<sup>2</sup>C, etc.
Line 357: Line 248:
 
**Current MPLAB ASM30 Assembler: v2.04
 
**Current MPLAB ASM30 Assembler: v2.04
 
**Current MPLAB C30 Compiler: v2.04
 
**Current MPLAB C30 Compiler: v2.04
 +
*'''Important Note''': Only the compiler is free. The header files and library are owned by Microchip.
  
*[http://gcc.gnu.org/ml/gcc/2005-02/msg01144.html John Steele Scott] has made templates that can be readily used by Debian-based systems.
+
{|border="1" cellspacing="0" cellpadding="5"
*For v1.32, the necessary conversion to *.deb has been done already at [http://noel.feld.cvut.cz/dspic/ here].
+
|+ Pic30 C-Compiler Toolchain Templates for Conversion to Debian-based systems
**Download '''pic30-1.32-debian.tar.bz2''' for Template v1.32.
+
! Toolchain Source !! Instruction !! Remarks
**Download '''pic30-binutils_1.32-1_i386.deb''' for the assember.
+
|-valign="top"
**Download '''pic30-gcc_1.32-1_i386.deb''' for the compiler.
+
| [http://www.baycom.org/~tom/dspic/ v2.00]
*For v2.00
+
| Download pic30-gcc-2.00-1.i386.rpm and pic30-binutils-2.00-1.i386.rpm.<br>Convert to deb files.
**goto http://www.baycom.org/~tom/dspic/
+
| Stable<br>Now using
**download pic30-gcc-2.00-1.i386.rpm and pic30-binutils-2.00-1.i386.rpm
+
|-valign="top"
**convert to deb files
+
| [http://www.nabble.com/Debian-templates-for-dsPIC-build-toolchain-2.05-td7886279.html v2.05]
**install these two deb files
+
| Reference to example below, but use 2.05 files
*For v3.01, convert the Toolchain following instructions at [http://www.nabble.com/Debian-templates-for-dsPIC-build-toolchain-3.01-tf4308624.html here]
+
| Can compile<br>Stable but not heavily tested
**Pre-install these packages: dpkg-dev, debhelper, bison, flex, sysutils, gcc-3.3, fakeroot
+
|-valign="top"
***cmd: '''sudo apt-get install dpkg-dev debhelper bison flex sysutils gcc-3.3 fakeroot'''
+
| [http://www.nabble.com/Debian-templates-for-dsPIC-build-toolchain-3.01-tf4308624.html v3.01]
**Download and unzip template: '''pic30-3.01.tar.bz2'''
+
| Follow example below
**Download assembler: '''mplabalc30v3_01_A.tar.gz'''. Save under /pic30-3.01/pic30-binutils-3.01/upstream/
+
| Can compile<br>Unstable (sometime produce segmentation fault)
**Download c-compiler: '''mplabc30v3_01_A.tgz'''. Save under /pic30-3.01/pic30-gcc-3.01/upstream/
+
|-valign="top"
**Install MPLAB_C30_v3_01-StudentEdition under Windows
+
| [http://www.nabble.com/Debian-Template-Patches-for-C30-v3.10-i386-td17534084.html v3.10]
**Copy directories /include, /lib, /support, and /bin/c30_device.info to pic30-3.01/pic30-support-3.01/upstream/
+
| Reference to example below, but use 3.10 files
**Pack pic30-binutils into deb file
+
| Cannot compile yet (segmentation fault)
***goto /pic30-3.01/pic30-binutils-3.01/
+
|-
***type cmd: '''dpkg-buildpackage -rfakeroot -b'''
+
|}
**Pack pic30-gcc-3.01 into deb file
+
====Conversion Example====
***goto /pic30-3.01/pic30-gcc-3.01/
+
*Pre-install these packages: dpkg-dev, debhelper, bison, flex, sysutils, gcc-3.3, fakeroot
***type cmd: '''dpkg-buildpackage -rfakeroot -b'''
+
**cmd: '''sudo apt-get install dpkg-dev debhelper bison flex sysutils gcc-3.3 fakeroot'''
**Pack pic30-gcc-3.01 into deb file
+
*Download and unzip template: '''pic30-3.01.tar.bz2'''
***goto /pic30-3.01/pic30-support-3.01/
+
*Download assembler: '''mplabalc30v3_01_A.tar.gz'''. Save under /pic30-3.01/pic30-binutils-3.01/upstream/
***type cmd: '''dpkg-buildpackage -rfakeroot -b'''
+
*Download c-compiler: '''mplabc30v3_01_A.tgz'''. Save under /pic30-3.01/pic30-gcc-3.01/upstream/
**install pic30-binutils_3.01-1_i386.deb
+
*Install MPLAB_C30_v3_01-StudentEdition under Windows
***type cmd: '''sudo dpkg -i pic30-binutils_3.01-1_i386.deb'''
+
*Copy directories /include, /lib, /support, and /bin/c30_device.info to pic30-3.01/pic30-support-3.01/upstream/
**install pic30-gcc_3.01-1_i386.deb
+
*Pack pic30-binutils into deb file
***type cmd: '''sudo dpkg -i pic30-gcc_3.01-1_i386.deb'''
+
**goto /pic30-3.01/pic30-binutils-3.01/
**install pic30-support_3.01-1_all.deb
+
**type cmd: '''dpkg-buildpackage -rfakeroot -b'''
***type cmd: '''sudo dpkg -i pic30-support_3.01-1_all.deb'''
+
*Install pic30-binutils_3.01-1_i386.deb
*'''Important Note''': Only the compiler is free. The header files and library are owned by Microchip.
+
**type cmd: '''sudo dpkg -i pic30-binutils_3.01-1_i386.deb'''
**Thomas Sailer suggested to download the Student version of C30 compiler and then build the libraries without source code. A package template for Fedora system is available [http://www.baycom.org/~tom/dspic/ here].
+
*Pack pic30-gcc-3.01 into deb file
**Instructions for filling the upstream direction is available [http://forum.microchip.com/printable.aspx?m=139360 here].
+
**goto /pic30-3.01/pic30-gcc-3.01/
**Alteratively, [https://gna.org/projects/pic30-libc/ Stephan Walter] has started a project to develop C Runtime Library for dsPIC.
+
**type cmd: '''dpkg-buildpackage -rfakeroot -b'''
***Current libraries in version 0.1.1 include: assert.h, cdefs.h, ctype.h, errno.h, inttypes.h, stdint.h, stdio.h, stdlib.h, string.h
+
*Install pic30-gcc_3.01-1_i386.deb
 +
**type cmd: '''sudo dpkg -i pic30-gcc_3.01-1_i386.deb'''
 +
*Pack support files into deb file
 +
**goto /pic30-3.01/pic30-support-3.01/
 +
**type cmd: '''dpkg-buildpackage -rfakeroot -b'''
 +
*Install pic30-support_3.01-1_all.deb
 +
**type cmd: '''sudo dpkg -i pic30-support_3.01-1_all.deb'''
 +
*After installation, locations of
 +
**C-Header (*.h): /usr/pic30-elf/include
 +
**Libraries (*.a): /usr/pic30-elf/lib
 +
**Assembly header (*.inc): /usr/share/pic30-support/inc
 +
**Linkerscript (*.gld): /usr/share/pic30-support/gld
  
*Burning Program Codes to Target Board
+
===Burning Program Codes to Target Board===
 
#Use 'dspicprg and dspicdmp' utilities developed by [http://homerreid.ath.cx/misc/dspicprg/ Homer Reid] to burn hex code (*.hex) to devices. See Reference [http://forum.microchip.com/tm.aspx?m=94243 here]. Through serial port only?
 
#Use 'dspicprg and dspicdmp' utilities developed by [http://homerreid.ath.cx/misc/dspicprg/ Homer Reid] to burn hex code (*.hex) to devices. See Reference [http://forum.microchip.com/tm.aspx?m=94243 here]. Through serial port only?
 
#Use [http://piklab.sourceforge.net/ Piklab IDE]. Details on file format not known.
 
#Use [http://piklab.sourceforge.net/ Piklab IDE]. Details on file format not known.
Line 406: Line 309:
  
 
{|border="1" cellspacing="0" cellpadding="5"
 
{|border="1" cellspacing="0" cellpadding="5"
|+ Table 4.2 Comparison between differnt optimization levels
+
|+ Comparison between differnt optimization levels
 
! Optimization !! Description !! Project 1<br>Code Size<br>(byte) !! Project 1<br>Data Usage<br>(byte) !! Project 2<br>Code Size<br>(byte) !! Project 2<br>Data Usage<br>(byte)
 
! Optimization !! Description !! Project 1<br>Code Size<br>(byte) !! Project 1<br>Data Usage<br>(byte) !! Project 2<br>Code Size<br>(byte) !! Project 2<br>Data Usage<br>(byte)
 
|-valign="top"
 
|-valign="top"
Line 432: Line 335:
  
  
==Software Architecture==
+
==[[freertos_posix Development | Driver Development]]==
                +--------+--------+--------+--------+--------+
+
*Description on developing drivers with POSIX API
  Application  | Task 1 | Task 2 | Task 3 | Task 4 | Task 5 |
 
                +--------+--------+--------+--------+--------+
 
                |                POSIX API                  |
 
                +-------------------+------------------------+
 
    OS        |    Coroutine      |  FreeRTOS Scheduler  |
 
                +-------------------+------------------------+
 
                |                  Drivers                  |
 
                +------+-----+-----+--------+-------+--------+
 
  Hardware    | UART | ADC | DAC | EEPROM |  PWM  | TIMERS |
 
                +------+-----+-----+--------+-------+--------+
 
*Currently, operating system is based on [http://www.freertos.org/ FreeRTOS] incorporating coroutine developed by [http://www.chiark.greenend.org.uk/~sgtatham/coroutines.html Simon Tatham]
 
*Software Drivers are to be developed to allow users at Application Level to use the hardware (e.g. ADC, DAC, UART, EEPROM etc) through the OS.
 
*The interface between the drivers and the OS is based on [http://www.die.net/doc/linux/man/man2/ POSIX standard] (e.g. open(), write(), read(), ioctl(), usleep() etc).
 
*The most up-to-date development can be found at repository [http://chungyan5.no-ip.org/vc/?root=freertos_posix freertos_posix]
 
 
 
 
 
==[[Programming Tips]]==
 
 
 
==Bootloader Development==
 
 
 
===Concepts===
 
*Programming with ICSP is useful when the target board is produced in batch. The producer can download a program even when the chip is on the target board.
 
*However, ICSP requires an external programmer.
 
*To allow the user to change the program after production but without the need of an external programmer, bootloader becomes useful.
 
*Bootloader is a small program installed via ICSP. Everytime the device is reset, the bootloader is run first. The bootloader first detects the default serial channel whether the user wishes to download a new program to the device. If so, the bootloader will pause there, and wait for the user to download the hex file from the PC. The hex file is written to the device via RTSP instructions in the bootloader. If a new download is not necessary, the bootloader redirects to the previously installed user's program.
 
*The disadvantage of bootloaders is that they consume some of the memory of the device.
 
 
 
 
 
{| border="1" cellspacing="0" cellpadding="5"
 
|+ Table 7.1 Free bootloaders for dsPIC
 
! Developer
 
! Source
 
! Platform
 
! User Guide
 
! Remarks
 
|- valign="top"
 
| [http://www.ingenia-cat.com/index.php?lang=en ingenia]
 
| [http://www.ingenia-cat.com/download/iBL.s Assembly]
 
| [http://www.ingenia-cat.com/download/ingeniadsPICbootloader1.1.zip Windows]
 
| [http://www.ingenia-cat.com/reference/pdf/iBL.UG.V1.2.pdf pdf]
 
|
 
*Works for all dsPIC supporting RTSP
 
*Auto baudrate detection
 
*Use about 1.15% of the flash memory space (0xAFFF-0xAE00)/(0xAFFF-0x0100)
 
*Development of Linux platform is underway
 
*Modification of code for dsPIC30F5011 is successful
 
|-valign="top"
 
| [http://www.etc.ugal.ro/cchiculita/software/picbootloader.htm Tiny]
 
| [http://www.etc.ugal.ro/cchiculita/software/tinybld191.zip Assembly]
 
| Windows
 
| [http://www.etc.ugal.ro/cchiculita/software/tinybldusage.htm Web]
 
|
 
*By default, only supports 601X, 601X, 401X, 2010
 
*Smaller code size than ingenia, but not as easy to modify
 
|-valign="top"
 
| [http://www.via.si/software/dsPIC_bootloader/ Elektronika]
 
| [http://www.via.si/software/dsPIC_bootloader/data/ Hex]
 
| Windows
 
| [http://www.via.si/software/dsPIC_bootloader/data/README.txt txt]
 
|
 
*Only works for dsPIC30F6014 serial port UART2 at baudrate 57600
 
|-
 
|}
 
 
 
===dsPicBootloader===
 
 
 
*The bootloader developed by ingenia is open source and it has been modified (see below) to suit our development using dsPic30f5011.
 
*The bootloader (hereafter called dsPicBootloader) employs the following settings:
 
# Use U2ART channel
 
# Use FRC, PLL16
 
# For 5011, the bootloader is located between 0x00AE00 to 0x00AFFE (512bytes). Refer to C:\Program Files\Ingenia\ingeniadsPICbootloader\ibl_dspiclist.xml after installing the GUI interface.
 
*Changes made to [http://www.ingenia-cat.com/download/iBL.s assembly code]  includes:
 
1. including p30f5011.gld and p30f5011.inc
 
        .include "p30f5011.inc"
 
2. changing the config code of UART #0x8420 -> #0x8020
 
        ; Uart init
 
        mov '''#0x8020''', W0          ; W0 = 0x8020 -> 1000 0000 0010 0000b
 
        mov W0, U2MODE            ; Enable UART, AutoBaud and 8N1
 
        clr U2STA
 
3. changing the start address 0xAE00 - 0x0100 = 0AD00
 
          .equ CRC, W4
 
          .equ ACK, 0x55
 
          .equ NACK, 0xFF
 
          .equ USER_ADDRESS, 0x0100
 
          .equ START_ADDRESS, '''0xAD00'''                ; Relative to 0x0100
 
4. using Internal FRC and PLL16
 
        config __FOSC, CSW_FSCM_OFF & '''FRC_PLL16''' ;Turn off clock switching and
 
                                          ;fail-safe clock monitoring and
 
                                            ;use the Internal Clock as the
 
                                          ;system clock
 
5. disabling MCLR (optional)
 
        config __FBORPOR, PBOR_ON & BORV_27 & PWRT_16 & '''MCLR_DIS'''
 
                                            ;Set Brown-out Reset voltage and
 
                                            ;and set Power-up Timer to 16msecs
 
6. changing all the related registers of U1ART to U2ART, all U1XXX => U2XXX
 
        '''U2MODE, U2STA, U2BRG, U2RXREG, U2TXREG'''
 
7. changing all the related registers of IC1 to IC2, all IC1XXX => IC2XXX
 
        '''IC2CON, #IC2IF, #IC2IE'''
 
 
 
===dsPicProgrammer (Java-based Multi-Platformed)===
 
*Ingenia developed a programmer (PC-side) that works only in Windows environment. The project for Linux environment is currently suspended.
 
*A simple programmer (hereafter called dsPicProgrammer) written in Java based on the library developed by [http://www.rxtx.org/ RXTX] has been developed here. The programmer supports both Linux and Windows environments, and may be used as a substitution for the official programmer developed by ingenia.
 
*The programmer has the following specification and limitations:
 
#Can be used on both Linux and Windows platforms.
 
#Adjustable baudrate (9600bps to 57600bps<sup>[1]</sup>).
 
#Support programming of dsPIC30F5011 and dsPIC33FJ128GP306<sup>[2]</sup> devices (Developers may add your devices).
 
#Protection against overwriting bootloader codes on devices.
 
#Detection if application program does not have its reset() at user's code start address.
 
#Reprogramming can be done without powering down the target board, provided the user's program is compliant to that stated below.
 
#Target board will run the user's program after programming is done.
 
#Can be used with USB-Serial Cables. Below is a list of tested cable:
 
::[http://www.prolific.com.tw/eng/Products.asp?ID=59 Prolific PL-2303 USB to Serial Bridge Controller]: [http://www.prolific.com.tw/eng/downloads.asp?ID=31 Driver download]
 
'''NOTE:'''<br>
 
[1] from version 1.5.2 onwards, the baudrate is increased to 115200bps.<br>
 
[2] only dsPIC30 devices are compatible with the ingenia's programmer. For dsPIC33 devices, the protocol has been modified due to the increased flash size, and the dsPIC33 bootloader can only work with dsPicProgrammer.
 
 
 
===Special Consideration===
 
*The bootloader assumes that the user program starts at address 0x100. This is usually the case, but there are always exceptions.
 
*To ensure that the user program always starts at address 0x100, you can create a customized linker script and customized reset() function as follows:
 
:*Copy and modify the file named "crt0.s" from the directory "C:\Program Files\Microchip\MPLAB C30\src\pic30" to the project directory and include it.
 
    .section .reset, code      //previously .section .libc, code
 
:*Copy and modify the linkerscript for the device (e.g. p30f5011.gld) to the project directory and include it.
 
  .text __CODE_BASE :
 
  {
 
      *(.reset);              //<-insert this line here
 
      *(.handle);
 
      *(.libc) *(.libm) *(.libdsp);  /* keep together in this order */
 
      *(.lib*);
 
      *(.text);
 
  } >program
 
 
 
===Communication Protocol===
 
 
 
          +-------------------+            +-------------------+----------------+
 
          |  dsPicProgrammer  |            |  dsPicBootloader  | User's Program |
 
          +-------------------+            +-------------------+----------------+
 
          |      PC          |            |            Target dsPic          |
 
          +-------------------+            +------------------------------------+
 
          |    COM PORT      |=============|                UART              |
 
          +-------------------+            +------------------------------------+
 
 
 
* '''Stage 1: User's Configuation'''
 
**Select a COM port channel
 
**Select a baudrate
 
**Select the user hex file
 
          java -jar dsPicProgrammer.jar COM1 19200 foo.hex
 
* '''Stage 2: Resetting Target Device'''
 
**dsPicProgrammer sends a Break character (pull UART-TX to low logic, which is normally high).
 
**User's program on dsPic detects the break character and reset the chip
 
::NOTE: The user's program is expected to have the following code in order to enable this function. Otherwise, the target board must be restarted manually.
 
  void _ISR _U2RXInterrupt(void)
 
  {
 
      //No Framming error
 
      if( U2STAbits.FERR == 0)
 
      {
 
          //Normal procedure
 
      }
 
      //Framming error
 
      else
 
      {
 
          if ( U2STAbits.URXDA ){
 
              unsigned char data;
 
              data = (unsigned char) U2RXREG;
 
              if(data == 0x00){
 
                  // A break char has been received:
 
                  //  U2RX has been pulled to zero for more than 13 bits
 
                  //  This is used to reboot the pic
 
                  mdelay(800);    //wait for break character to clear
 
                  asm("reset");  //software reset
 
              }
 
          }       
 
      }
 
      _U2RXIF = 0;        //Clear the flag
 
  }
 
* '''Stage 3: Entering Ingenia's Protocol'''
 
** Transmission is conducted in 8N1, i.e. 8-bit, no parity, 1 stop-bit
 
** Communication Protocol is reviewed in [http://www.ingenia-cat.com/reference/pdf/iBL.UG.V1.2.pdf ingenia bootloader user's guide] section 2.1.3. The following summarises the key steps on the PC side (Refer also to section 2.2.2).
 
::#Autobaud rate detection: dsPicProgrammer continuously sends a character "U" [0x55] via COM port and waits for an acknowledgment character "U", [ACK] = [0x55]
 
::#Version Control: dsPicProgrammer sends the command character [0x03]. On success, dsPicProgrammer receives 3 characters i) Major Version ii) Minor Version iii) Acknowledgment [0x55]
 
::#Device ID Monitoring: dsPicProgrammer sends the read command character [0x01] + 24-bit address [High][Medium][Low] (0xFF0000). Then, it receives 4-byte data [High][Medium][Low][ACK]
 
::#Load the user hex file and check integrity
 
::#Start Programming: dsPicProgrammer issues the write command character [0x02] + 24-bit address [High][Medium][Low]+ Number of bytes [N] + [data 0] + [data 1] + ... + [data N-1] + [CRC]=(INTEL HEX8 Checksum - Sum modulo 256) and receives [ACK] or [NACK] = [0xFF]
 
::NOTE: Writing is in row mode access (i.e. erase and write a whole row, each row has 32 instructions, or 96 bytes because each instruction has 24 bits)
 
* '''Stage 4: Goto User's Program'''
 
**dsPicProgrammer sends the goto user code command [0x0F]
 
 
 
 
 
==USB-RS232 Bridge==
 
 
 
*As USB ports are becoming more and more common, COM ports and Parallel ports may be redundant in the next few years. This section explore the possibilities of programming the target board through a USB port.
 
*There are two options:
 
#Use an external USB/RS232 adaptor, the driver will emulate a virtual COM port, such as [http://www.prolific.com.tw/eng/downloads.asp?ID=31 Prolific] and [http://www.ftdichip.com/Drivers/VCP.htm FDTI]. Ingenia has tested its bootloader with some USB-232 manufacturers (silabs, FTDI, etc..). However, the programming failed with our Prolific adapter. Application program may use [http://java.sun.com/products/javacomm/ JavaComm API] (javax.comm) and/or [http://www.rxtx.org/ RXTX] to drive the COM port.
 
#Modified the bootloader program on PC to support USB communication. e.g. using [http://jusb.sourceforge.net/ jUSB] and [http://javax-usb.org/ JSR-80] (javax.usb). External circuits such as PIC18F4550 and MAX232 are required.
 
 
 
    |--User's App.--|-------Device Manager------|-------USB-RS232 Interface------|---dsPIC---|
 
  Option 1:
 
    +-------------+  +----------+  +----------+  +---+  +------------+  +-----+  +--------+
 
    | Application |--| JavaComm |--| Virtual  |==|USB|--|    FDTI    |--|RS232|==| Target |
 
    |  Program  |  |  RXTX    |  | COM Port |  +---+  | Circuitary |  +-----+  | Board  |
 
    +-------------+  +----------+  +----------+        +------------+          +--------+
 
  Option 2:
 
    +-------------+          +--------+          +---+  +------------+  +-----+  +--------+
 
    | Application |----------| JSR-80 |==========|USB|--| PIC18F4550 |--|RS232|==| Target |
 
    |  Program  |          |  jUSB  |          +---+  |  MAX232  |  +-----+  | Board  |
 
    +-------------+          +--------+                +------------+          +--------+
 
 
 
*Currently, when RXTX is incorporated with JavaComm API, operating systems supported include Linux, Windows, Mac OS, Solaris and other operating systems. On the other hand, jUSB and JSR-80 only works for linux.
 
 
 
===FDTI Chipset===
 
*FT232RL communicates with PC via USB to provide 1 UART channel.
 
*Datasheet can be downloaded [http://www.ftdichip.com/Documents/DataSheets/DS_FT232R.pdf here].
 
**Refer to Fig. 11 (Page 19) for Bus Powered Configuration.
 
**Refer to Fig. 16 (Page 24) for for UART TTL-level Receive [RXD -> 1], Transmit [TXD -> 4], Transmit Enable [CBUS2/TXDEN -> 3]. Omit Receive Enable [CBUS3/PWREN#] and use [CBUS2/TXDEN -> 2]
 
**Refer to Fig. 15 (Page 23) for LED Configuration: [CBUS0/TXLED#] and [CBUS1/RXLED#]
 
*Virtual COM Port Drivers can be downloaded [http://www.ftdichip.com/Drivers/VCP.htm here].
 
 
 
 
 
==Programming the Device==
 
 
 
===Requirements===
 
*Hardware
 
#PC with COM port (Windows XP Installed for MPLAB)
 
#ICD2 Programmer
 
#Target Board
 
#5V Power Supply
 
 
 
*Software
 
#[http://ww1.microchip.com/downloads/en/DeviceDoc/MP750.zip MPLAB IDE v7.50]: v7.60 is not compatible with our current [http://www.sure-electronics.com/ ICD2 Programmers]. There are consistent "Devices cannot be founded" warnings.
 
#[http://chungyan5.no-ip.org/websvn/listing.php dsPicProgrammer] ('''dsPicProgrammer.jar''')
 
#[http://users.frii.com/jarvi/rxtx/download.html RXTX driver]: download and upzip rxtx-2.1-7-bins-r2.zip (Final)
 
 
 
*Files
 
#[http://chungyan5.no-ip.org/websvn/listing.php dsPicBootloader] ('''bl_5011.hex'''). Original assembly code by ingenia can be downloaded from [http://www.ingenia-cat.com/download/iBL.s here].
 
#Application hex file (e.g. '''app.hex''')
 
 
 
===Loading Bootloader (Once only)===
 
{|border="1" cellspacing="0" cellpadding="5"
 
|+ Table 9.1 Loading Bootloader
 
! Step !! Remarks
 
|-valign="top"
 
| Install [http://ww1.microchip.com/downloads/en/DeviceDoc/MP750.zip MPLAB IDE] ||
 
*Do '''NOT''' connect ICD 2 (via USB) to PC
 
*Execute '''MPLAB vX.XX Install.exe'''
 
|-valign="top"
 
| Install USB Driver ||
 
*Follow the instruction in (C:\Program Files\Microchip\MPLAB IDE\ICD2\Drivers\Ddicd2.htm)
 
|-valign="top"
 
| Select Target Chip ||
 
*Run MPLAB IDE on PC
 
*Select: Configure>Select Devices...
 
*Choose dsPIC30F5011
 
|-valign="top"
 
| Target <-> ICD 2  ||
 
*Use six pin cable. Beware of the pin assignments. Only pin 1 - 5 should be used.
 
*Place Jumper on target board (if any). The Jumper connects target V<sub>cc</sub> to ICD 2.
 
*Do '''NOT''' power-up the target.
 
|-valign="top"
 
| ICD 2 <-> PC ||
 
*Plug-in ICD 2 to PC via USB cable
 
*Power-up the target.
 
*Select: Programmer>Select Programmer>MPLAB ICD 2
 
*If this is the first time the ICD 2 is connected to PC, MPLAB IDE will automatically download the required OS to ICD 2, wait until it has finished
 
*If you have not connected and powered up the target, you might see Warnings on invalid device IDs, and/or running self tests.
 
*See results of self test if necessary: Programmer>Settings, Status Tab. Refer to [http://ww1.microchip.com/downloads/en/DeviceDoc/51331B.pdf ICD2 User's Guide] Chapter 7.
 
|-valign="top"
 
| Load Bootloader ||
 
*Select: File>Import...
 
*Select '''bl_5011.hex'''
 
|-valign="top"
 
| Start Programming ||
 
*Select: Programmer>Program
 
|-valign="top"
 
| Finishing ||
 
*Power-down the Taget
 
*Select: Programmer>Select Programmer>None
 
*Unplug USB cable
 
|-
 
|}
 
 
 
===Loading Firmware===
 
<!--using Firefox-File-Page_Setup-Format-Scale-85% to print -->
 
====Java Environment Setup====
 
*Download and install the latest JDK or JRE
 
**Available from [http://java.sun.com/javase/downloads/index.jsp Sun Microsystems] (e.g. JDK 6 Update 3)<br>[[Image:1 1 java.JPG]]<br>
 
*Download and Extract RXTX Driver
 
**Available from [http://users.frii.com/jarvi/rxtx/download.html RXTX]
 
**File: rxtx-2.1-7-bins-r2.zip (Final)
 
**Extract the files using software such as WinRAR<br>[[Image:1 2 rxtx.JPG]]<br>
 
*Copy RXTXcomm.jar to
 
**For Windows users, C:\Program Files\Java\X\lib\ext (under the latest jre, e.g. X = jre1.6.0_03)
 
**For Linux users, /usr/lib/jvm/java-version/jre/lib/ext<br>[[Image:1 3 rxtxcomm.JPG]]<br>
 
*Copy rxtxSerial.dll/librxtxSerial.so to
 
**For Windows users, C:\Program Files\Java\X\bin (under the lastest jre, e.g. X = jre1.6.0_03)
 
**For Linux users, /usr/lib/jvm/java-version/jre/lib/[machine type] (i386 for instance)<br>[[Image:1 4 rxtxserial.JPG]]<br>
 
*Download dsPicProgrammer
 
**Available from [http://chungyan5.no-ip.org/vc here]
 
**Expand the latest tag under dsPicProgrammer
 
**File: dsPicProgrammer.jar<br>[[Image:1 5 dspicprogrammer.JPG]]<br>
 
**Save the file (dsPicProgrammer.jar) and your hex file (foo.hex) to your local directory (e.g. C:\dsPicProgrammer\)<br>[[Image:1 6 dspicprogrammer2.JPG]]<br>
 
=====directly download this [http://chungyan5.no-ip.org/open_data/electronic_computer/platforms/dspic/dsPicProgrammer/dsPicProgrammer1.5.2.zip package]=====
 
 
 
====Download Firmware====
 
*Start a Command Prompt
 
**Start -> Run<br>[[Image:2 1 run.JPG]]<br>
 
**Enter cmd<br>[[Image:2 2 cmd.JPG]]<br>
 
*Run dsPicProgrammer
 
**Make sure your device is connected through a "Direct RS232 Cable" to PC Serial Port.
 
**Change to the directory where dsPicProgrammer.jar is located and run the command:
 
***[path/to/java/]java -Djava.library.path=[path/to/rxtxlib] -jar dsPicProgrammer.jar COM1 57600 foo.hex
 
****for example, jre\bin\java -Djava.library.path=.\rxtx\bin -jar dspicProgrammer.jar COM1 57600 foo.hex
 
***Or directly using dsPicProgrammer.bat COM1 57600 foo.hex(Windows)
 
***java -jar dsPicProgrammer.jar /dev/ttyS0 57600 foo.hex (Linux)
 
:::where COM1 is your COM Port ID
 
:::57600 is communication speed [in bps]
 
:::foo.hex is your firmware new file
 
::[[Image:2 3 command.JPG]]
 
**When the program prompt you for an input, press y:<br>[[Image:2 4 prompt.JPG]]<br>
 
**If communication can be established, you should see something like this:<br>[[Image:2 5 progress.JPG]]<br>
 
**Wait until programming is completed.<br>[[Image:2 6 complete.JPG]]<br>
 
**after all completed, power OFF your device, then power ON again, enjoy your new updated.
 
 
 
====Troubleshooting====
 
*Invalid COM Port
 
**In case of selecting an invalid COM port, you should see the error message:<br>gnu.io.NoSuchPortException: Choosing COM Port Error<br>[[Image:3 1 com err.JPG]]<br>
 
*Missing firmware file
 
**In case of selecting a firmware file that does not exist, you should see the error message:<br>java.io.FileNotFoundException: foo1.hex <The system cannot find the file specified><br>[[Image:3 2 file err.JPG]]<br>
 
*Missing RXTX driver
 
**In case of missing the RXTX driver, you should see the error message:<br>Exception in thread “main” java.lang.NoClassDefFoundError: gnu/io/UnsupportedCommOperationException<br>[[Image:3 3 rxtx err.JPG]]<br>
 
 
 
==Remote Access==
 
*At the moment, local devices (e.g. EEPROM, ADC, DAC, etc.) can only be accessed locally through POSIX functions such as open(), read(), write(), ioctl().
 
*However, a client may need to access these devices on a remote server. This section reviews the background and gives some ideas on its possible implementation.
 
 
 
===Requirements===
 
*A remote file access protocol, to transfer "files" (i.e. device's data) such as:
 
#[http://en.wikipedia.org/wiki/FTP File Transfer Protocol] (FTP): Required files are copied from sever to client for manipulation
 
#[http://en.wikipedia.org/wiki/Remote_Shell Remote Shell] (RSH): Required files are copied from sever to client for manipulation
 
#[http://en.wikipedia.org/wiki/Network_File_System_%28Sun%29 Network File System] (NFS): Required files are manipulated on sever
 
*An API to access files using a selected protocol, such as:
 
#[http://www.die.net/doc/linux/man/man2/lam_rfposix.2.html lam_rfposix]: A POSIX-like remote file service for Local Area Multicomputer
 
#API employed by VxWorks: [http://en.wikipedia.org/wiki/VxWorks VxWorks] is a Unix-like real-time operating system, commonly used for embedded systems.
 
 
 
===API Reference for VxWorks===
 
*Reference:
 
**[http://www.windriver.com/vxworks/ VxWorks Official Website]
 
**[http://www-cdfonline.fnal.gov/daq/commercial/ OS Libraries API Reference]
 
*Related Libraies
 
**netDrv (netDrv.h): an API using FTP or RSH
 
**nfsDrv (nfsDrv.h): an API using NFS
 
 
 
 
 
==Conversion to dsPIC33F Devices==
 
*This section discusses the conversion required from dsPIC30F5011 to dsPIC33FJ128GP306.
 
*Refer to official document [http://ww1.microchip.com/downloads/en/DeviceDoc/70172A.pdf dsPIC30F to dsPIC33F Conversion Guidelines] (DS70172A).
 
*Note that this section does not mainly intend to introduce the new functionalities of dsPIC33F devices. It only serves the purpose to summarise the major (if not minimum) changes required to port the setup of dsPIC30 to dsPIC33 devices.
 
 
 
===Hardware===
 
*dsPIC33 operates at voltage of 3.3V. A voltage regulator, such as [http://www.national.com/ds.cgi/LM/LM3940.pdf LM3940] can be used to convert 5V supply to 3.3V.
 
*A 1uF capacitor has to be placed at pin 56 (previously V<sub>SS</sub>, now V<sub>DDCORE</sub>).
 
 
 
===Software===
 
 
 
====Configuration Bits====
 
 
 
----
 
*dsPIC33 can operate at 40MIPs at maximum. To configure the device using internal FRC, replace the configuration bits setting as follows:
 
  _FOSCSEL(FNOSC_FRCPLL);  // FRC Oscillator with PLL
 
  _FOSC(FCKSM_CSDCMD & OSCIOFNC_ON  & POSCMD_NONE); 
 
                            // Clock Switching and Fail Safe Clock Monitor is disabled
 
                            // OSC2 Pin Function: OSC2(RC15) as Digital IO
 
                            // Primary Oscillator Mode: Disabled
 
  _FWDT(FWDTEN_OFF);      // Watchdog Timer Enabled/disabled by user software
 
*Configure on-chip PLL at runtime as follows (at start of main function):
 
  _PLLDIV = 38;            // M=40: PLL Feedback Divisor bits
 
  CLKDIV = 0;              // N1=2: PLL VCO Output Divider Select bits
 
                            // N2=2: PLL Phase Detector Input Divider bits
 
  OSCTUN = 22;              // Tune FRC oscillator, if FRC is used;
 
                            // 0: Center frequency (7.37 MHz nominal)
 
                            // 22: +8.25% (7.98 MHz)
 
  RCONbits.SWDTEN = 0;      // Disable Watch Dog Timer
 
  while(OSCCONbits.LOCK != 1); // Wait for PLL to lock
 
 
 
====UART====
 
 
 
----
 
*No change is required.
 
 
 
====I2C====
 
 
 
----
 
*dsPIC33 supports upto 2 I<sup>2</sup>C devices. As a result, replace all I<sup>2</sup>C related registers with xxI2Cyy to xxI2C'''1'''yy. For examples:
 
  _SI2C1IF = 0; //Clear Slave interrupt
 
  _MI2C1IF = 0; //Clear Master interrupt
 
  _SI2C1IE = 0; //Disable Slave interrupt
 
  _MI2C1IE = 0; //Disable Master interrupt
 
  I2C1BRG = I2C_BRG; // Configure Baud rate
 
  I2C1CONbits.I2CEN = 1;
 
  ...
 
  etc.
 
 
 
====ADC====
 
 
 
----
 
*The ADC in dsPic33 is significantly different from that in dsPic30. Specifically, ADC in dsPic33 uses DMA to buffer the adc data. Replace the open, interrupt routine, add and remove codes as follows:
 
 
 
  unsigned int adc_bufA[ADC_MAX_CH] __attribute__((space(dma),aligned(256)));
 
  unsigned int adc_bufB[ADC_MAX_CH] __attribute__((space(dma),aligned(256)));
 
  unsigned int* ADC16Ptr;            //Pointer to ADC register buffer,
 
  unsigned char adc_ch_select = 0;    //Pointer to channel to be read from
 
  unsigned char adc_data_ready = 0;  //Indicate if RAM data is ready for output
 
  unsigned int which_dma = 0;        //indicate which adc_buf to be used
 
 
 
  void adc_open(void)
 
  {
 
      // Configure interrupt
 
      _AD1IF = 0;              //clear ADC interrupt flag
 
      _AD1IE = 0;              //disable adc interrupt
 
      AD1CHSbits.CH0NA = 0;
 
      // Configure analog i/o 
 
      _TRISB0 = 1;
 
      _TRISB1 = 1;   
 
      AD1PCFG = 0xFFFC;        //Enable AN0 (Vref+) and AN1 (Vref-)
 
      AD1PCFGH = 0xFFFF;      //AN16-AN31: Disabled
 
      // Configure scan input channels   
 
      AD1CSSL = 0x0003;    //0 => Skip, 1 => Scan
 
      AD1CSSH = 0x0000;    //Skipping AN16-AN31
 
      // ADCCON4:
 
      AD1CON4bits.DMABL = 0;    // Each buffer contains 1 word
 
      // ADCCON3:
 
      AD1CON3bits.SAMC = 1; //1TAD for sampling time
 
      AD1CON3bits.ADRC = 0;            //Use system clock
 
      AD1CON3bits.ADCS = ADC_ADCS;    //each conversion requires 14TAD
 
      // ADCCON2:
 
      AD1CON2bits.VCFG = 3;    //External Vref+, Vref-
 
      AD1CON2bits.CSCNA = 1;  //Scan input
 
      AD1CON2bits.SMPI = 1;    //2 channels are scanned
 
      // ADCCON1:
 
      AD1CON1bits.FORM = 0;        //[0:integer]; [2 fractional]; [3 siged fractional]
 
      AD1CON1bits.SSRC = 7;        //auto covert, using internal clock source
 
      AD1CON1bits.ASAM = 1;        //auto setting of SAMP bit
 
      AD1CON1bits.AD12B = 1;      //12-bit, 1-channel ADC operation
 
      AD1CON1bits.ADDMABM = 0;    // DMA buffers are built in scatter/gather mode
 
      AD1CON1bits.ADON = 1;        // Turn on the A/D converter
 
      // DMA0 Configuration:
 
      DMA0CONbits.AMODE = 2;      // Configure DMA for Peripheral indirect mode
 
      DMA0CONbits.MODE  = 2;      // Configure DMA for Continuous Ping-Pong mode
 
      DMA0PAD=(int)&ADC1BUF0;   
 
      DMA0CNT = 1;                // generate dma interrupt every 2 samples
 
                                  // same as SMPI because only 1 dma buffer per channel       
 
      DMA0REQ = 13;              // Select ADC1 as DMA Request source
 
      DMA0STA = __builtin_dmaoffset(adc_bufA);   
 
      DMA0STB = __builtin_dmaoffset(adc_bufB);
 
      _DMA0IF = 0;                // Clear the DMA interrupt flag bit
 
      _DMA0IE = 1;                // Set the DMA interrupt enable bit
 
      DMA0CONbits.CHEN=1;        // Enable DMA
 
  }
 
 
 
  void _ISR _DMA0Interrupt(void)
 
  {
 
      ADC16Ptr = (which_dma == 0)? adc_bufA : adc_bufB;  //Update pointer
 
      adc_data_ready = 1;
 
      which_dma ^= 1;                                    //Next buffer to be used
 
      _DMA0IF = 0;                                        //Clear the DMA0 Interrupt Flag
 
  }
 
 
 
  static void adcAdd(unsigned char ch){
 
      unsigned int mask;
 
      mask = 0x0001 << ch;
 
      TRISB = TRISB | mask;
 
      AD1CSSL = AD1CSSL | mask;     
 
      AD1PCFG = ~AD1CSSL;
 
      AD1CON2bits.SMPI++;  //take one more sample per interrupt
 
      DMA0CNT++;
 
  }
 
 
 
  static void adcRm(unsigned char ch){
 
      unsigned int mask;
 
      mask = 0x0001 << ch;
 
      AD1PCFG = AD1PCFG | mask;
 
      AD1CSSL = ~AD1PCFG;
 
      AD1CON2bits.SMPI--;  //take one less sample per interrupt
 
      DMA0CNT--;
 
  }
 
 
 
====EEPROM====
 
 
 
----
 
*There is no EEPROM in dsPIC33 devices. Please consider to use an external EEPROM using I<sup>2</sup>C communication.
 
 
 
====Simple PWM====
 
 
 
----
 
*No change is required.
 
 
 
===Memory Map for dsPIC33FJ128GP306===
 
{| border="1" cellspacing="0" cellpadding="5"
 
|+ Table 11.1 Memory Location
 
! Type !! Start Address !! End Address !! Size
 
|-valign="top"
 
| Flash || 0x000000 ||0x0157FF || 86K<sup>[1]</sup>
 
|-valign="top"
 
| +--Flash: Reset Vector || 0x000000 ||0x000003 || 4
 
|-valign="top"
 
| +--Flash: Interrupt Vector Table || 0x000004 ||0x0000FF || 252
 
|-valign="top"
 
| +--Flash: Alternate Vector Table || 0x000104 ||0x0001FF || 252
 
|-valign="top"
 
| +--Flash: User Program || 0x000200 ||0x0157FF || 85.5K
 
|-valign="top"
 
| Programming Executive || 0x800000 || 0x800FFF || 4K<sup>[1]</sup>
 
|-valign="top"
 
| Config  Registers || 0xF80000 || 0xF80017 || 24
 
|-valign="top"
 
| Device ID (0xE5) || 0xFF0000 || 0xFF0003 || 4
 
|-
 
|}
 
[1] Each address is 16-bit wide. Every two addresses correspond to a 24-bit instruction. Each even address contains 2 valid bytes; each odd address contains 1 valid byte plus 1 phathom byte.<br>
 
  
===Custom Linker Script to Maximize Space for Constant Data===
 
*Constant data declared using keyword '''const''' will be stored in the .const section in the flash memory.
 
*Normally, during compilation, the linker will assign these data after the program code (.text section).
 
*Since .const is accessed by auto-psv function, to maximize the space for constant data (32kb), the .const section needs to be aligned at 0x80000 boundary.
 
*This requires the following change in linker script:
 
  
  __CONST_BASE = 0x8000;
+
==[[Bootloader Development]]==
 
+
*Description on concepts and development on bootloader
  .text __CODE_BASE :
+
*Description on dsPicProgrammer to download firmware via bootloader
  {
 
  *(.reset);
 
        *(.handle);
 
        *(.libc) *(.libm) *(.libdsp);  /* keep together in this order */
 
        *(.lib*);
 
        /* *(.text); deleted to maximize space for const data */
 
  } >program
 
 
 
  .const __CONST_BASE :
 
  {
 
  *(.const);
 
  } >program
 
  
*If your program is large, after this change in linker script, function calls may involve large jump in the memory map (>32kB). As a result, you may need to enable the large code and large memory model during compilation. In such case, use the following options in your build path:
 
    -mlarge-code -mlarge-data
 
*Meanwhile, functions that are defined in the standard C libraries, but are replaced with your own implementations (e.g. I/O stubs: open(), read(), write(), lseek(), ioctl() etc.) may have the following linker error:
 
    /usr/pic30-elf/lib//libc-elf.a(fflush.eo)(.libc+0x3c): In function '.LM11':
 
    : Link Error: relocation truncated to fit: PC RELATIVE BRANCH _write
 
    /usr/pic30-elf/lib//libc-elf.a(fclose.eo)(.libc+0x42): In function '.LM18':
 
    : Link Error: relocation truncated to fit: PC RELATIVE BRANCH _close
 
*To resolve the problem, you need to place the functions in the .libc section rather than in the .text section, like this:
 
    #define LIBC_CODE_LOC __attribute__ ( (section(".libc")))
 
   
 
    int LIBC_CODE_LOC open(const char *pathname, int flags){ ... }
 
    int LIBC_CODE_LOC close(int fd){ ... }
 
    int LIBC_CODE_LOC write(int fd, void* buf, int count) { ... }
 
    int LIBC_CODE_LOC read(int fd, void* buf, int count) { ... }
 
    int LIBC_CODE_LOC ioctl(int fd, int request, void* argp) { ... }
 
    int LIBC_CODE_LOC lseek(int fd, int offset, int whence) { ... }
 
  
===dsPicBootloader and dsPicProgrammer===
+
==[[Programming the Device]]==
*RTSP for dsPIC33F is different from dsPIC30F.
+
*Description on how to use dsPicProgrammer to download firmware to dspic
**Row size changes from 32 instructions (96bytes) to 64 instructions (192 bytes)
 
**Erase operation changes from 1 row to 8 rows
 
**No EEPROM
 
*With regards to the above changes, dsPicBootloader and dsPicProgrammer has been modified. In particular, dsPicProgrammer can be used to program both dsPic30F and dsPic33F devices (Yet, dsPic33F is no longer compatible with Ingenia's programmer). You can easily add your devices to the source code.
 
  
==Downloads==
 
{| border="1" cellspacing="0" cellpadding="5"
 
|+ Table 12.1 Related software download links for dsPicBootloader and dsPicProgrammer
 
! Program
 
! Site 1
 
! Site 2
 
! Remarks
 
|- valign="top"
 
| JDK
 
| [http://java.sun.com/javase/downloads/index.jsp website]
 
|
 
| Download latest JDK
 
|- valign="top"
 
| RXTX
 
| [http://users.frii.com/jarvi/rxtx/download.html website]
 
|
 
| Download rxtx-2.1-7-bins-r2.zip or later
 
|- valign="top"
 
| dsPicBootloader
 
| [http://chungyan5.no-ip.org/vc click]
 
| [http://www.opencircuits.com/images/a/a7/DsPicBootloader_1_3_1.zip click (v1.3)]
 
| Under "dsPicBootloader/", download bl_5011.s or bl_j128gp306.s
 
|-valign="top"
 
| dsPicProgrammer
 
| [http://chungyan5.no-ip.org/vc click]
 
| [http://www.opencircuits.com/images/9/9e/DsPicProgrammer_1_3_5.zip click (v1.3.5)]
 
| Under "dsPicProgrammer/", dowload dsPicProgrammer.jar<br><br>Alternatively, if you want to compile yourself or modify the source code, download <br>all source files under "dsPicProgrammer/" '''plus''' RdFileIntelHex.java under <br>"IntelHexPaser/tags/0.02.00/".<br>You should also install RXTX on your local machine as recommended in the readme file.
 
|- valign="top"
 
| Ingenia's bootloader
 
| [http://www.ingenia-cat.com/en/downloads.php website]
 
|
 
| Download original ingenia's bootloader
 
|-
 
|}
 
  
==ToDo==
+
[[category:projects]]
*dspic gcc compiler for constant problem
 
*add chip to stable voltage upon power failure or to detect low voltage, and generate interrupt for dsPic to execute shutdown routine (e.g. save important data to NVM, shutdown ethernet etc.)
 
*program the bootloader into flash under linux platform
 

Latest revision as of 07:30, 16 October 2012

This project aims to provide the development tools for building a multi-purpose MCU board. Description is based on Microchip dsPic33FJ256GP506 (was dsPic30F5011), but information provided in this wiki may give useful directions for developing similar embedded systems with different platforms.

Introduction

Features of dsPic33FJ256GP506

  • 3.0 to 3.3 V
  • Up to 40 MIPs
  • Maximum current sink/source for I/O pins: 4 mA
  • 16-bit arithmetics
  • DSP Instruction Set
  • Dual programming techniques: ICSP and RTSP
  • Memory
    • 256 KB flash (86K instructions)
    • 16 KB RAM (incl. 2 KB DMA RAM)
    • No EEPROM
  • Communications ports
    • UART
    • I2C: up to 1 Mbit/s
    • SPI
  • ADC
  • 10-bit A/D, 1.1 Msps
  • 12-bit A/D, 500 ksps
  • No DAC (PWMs only)
  • Pin-to-pin compatible with other dsPICs
Comparison between different dsPICs
dsPic *Price
US$
MIPs Flash
(kB)
RAM
(kB)
EEPROM
(kB)
I/O ADC
12-bit
IC OC Motor
Ctrl
Timers QEI UART SPI I2C CAN Codec
33FJ256GP506 6.11 40 256 16 0 53 18 8 8 0 9x16bit
4x32bit
0 2 2 2 1 1
33FJ128GP206 4.62 40 128 8 0 53 18 8 8 0 9x16bit
4x32bit
0 2 2 1 0 1
33FJ128GP306 4.81 40 128 16 0 53 18 8 8 0 9x16bit
4x32bit
0 2 2 2 0 1
33FJ128GP706 5.49 40 128 16 0 53 18 8 8 0 9x16bit
4x32bit
0 2 2 2 2 1
33FJ128MC506 4.97 40 128 8 0 53 16 8 8 8 9x16bit
4x32bit
1 2 2 2 1 0
33FJ128MC706 5.38 40 128 16 0 53 16 8 8 8 9x16bit
4x32bit
1 2 2 2 1 0

*For reference only, subject to change

Forums

  • Microchip: Official forum by Microchip
    • See MPLAB ICD 2, MPLAB IDE, MPLAB C30 Compiler, ASM30, Link30 forum, dsPIC30F Topics, dsPic33 topics
  • HI-TECH Software Forum: Discussion on dsPICC, a C compiler developed by HI-TECH
  • FreeRTOS Real Time Kernel: Open Discussion and Support on FreeRTOS
  • Nabble: MicroControllers - GNUPIC

References

Code Examples

Related Development


Programming Methods

  • There are 2 programming methods: In-Circuit Serial Programming (ICSP) and Run-Time Self-Programming (RTSP)
  • ICSP allows the devices to be programmed after being placed in a circuit board.
  • RTSP allows the devices to be programmed when an embedded program is already in operation.

ICSP: External Programmer (ICD2)

  • Two types of ICSP are available: ICSP and Enhanced ICSP. Both of them require setting MCLR# to VIHH (9V – 13.25V).
  • Standard ICSP
    • Use external programmer (e.g. MPLAB® ICD 2, MPLAB® PM3 or PRO MATE® II) only.
    • Required low-level programming to erase, program and verify the chip.
    • Slower, because codes are serially executed.
  • Enhanced ICSP
    • Use external programmer and Programming Executive (PE).
    • PE is stored in the on-chip memory.
    • PE allows faster programming.
    • PE can be downloaded to the chip by external programmer using the standard ICSP method.
    • PE contains a small command set to erase, program and verify the chip, avoiding the need of low-level programming.

Hardware Interface

Pin Used by ICSP
Pin Label Function Pin Number
MCLR# Programming Enable 7
VDD Power Supply 10, 26, 38, 57
VSS Ground 9, 25, 41, 56
PGC Serial Clock 17
PGD Serial Data 18


Available Programmers in the Market
Product Name Interface with PC Interface with Device *Price (US) Remarks
MPLAB® ICD 2 USB or RS232 6-PIN RJ-12 connector $159.99 -
Clone Microchip ICD2 (Now Using) USB 6-pin flat cables $52.35 Do not work with new MPLAB versions (works for 7.50), communication to MPLAB may sometime hang (see manual)

*For reference only (exclude shipping), subject to change


DIY ICD 2 Programmer Circuit
Source Schematic PIC16F877A Bootloader
Patrick Touzet Yes HEX
Nebadje Yes Zip


Software Interface

  • The program can be written and compiled in an Integrated Development Environment (IDE) using either Assembly or C. The complied codes are then loaded to the device through the external programmer.
Summary of IDE
Product Name Features OS Price (US$)
MPLAB® IDE Assembler Only Windows Free
MPLAB® C30 Assembler and C-Compiler Windows $895.00 (Free student version1)
Piklab Assembler and C-Compiler Linux Free
  1. Full-featured for the first 60 days. After 60 days, some code optimization functions are disabled. The compiler will continue to function after 60 days, but code size may increase.

RTSP: COM Port (Bootloader)

  • RTSP works in normal voltage (MCLR# no need to raise to VIHH).
  • No literature has mentioned the incorporation of Programming Executive (PE). Presumably, since Enhanced ICSP needs to set MCLR# to VIHH, RTSP cannot use PE.
  • Refer to bootloader section.


Development Environment

Windows

PIC setup win.JPG

  • C-Compiler, Assembler and Linker are under GNU license.
    • MPLAB C30 C Compiler (*.c -> *.s)
    • MPLAB ASM30 Assembler (*.s -> *.o)
    • MPLAB LINK30 Linker (*.o -> *.bin)
  • PA optimizer, simulator, runtime libraries, header files, include files, and linker scripts are not covered by GNU. Reference is here.
  • Microchip has integrated ASM30, LINK30, assembly header files, linker scripts in MPLAB IDE, which is free for download.
  • MPLAB C30 costs US$895. A 60-day free student version is also available. After 60-days, the optimizer is automatically disabled, while other tools can still function properly.


C Libraries in MPLAB C30
Library Directory
(\\Microchip\MPLAB C30)
Major functions
DSP Library
(e.g. libdsp-coff.a)
\lib
\src\dsp
\support\h
Vector, Matrix, Filter, etc.
16-Bit Peripheral Libraries \lib
\src\peripheral
\support\h
ADC12, IOPort, UART, I2C, etc.
Standard C Libraries
(e.g. libc-coff.a, libm-coff.a, libpic-coff.a)
\lib
\src\libm
\include
stdio.h, time.h, float.h, math.h,
MPLAB C30 Built-in Functions none _buildin_addab, _buildin_add, _buildinmpy, etc

Linux

PIC setup linux.JPG

  • C Compiler, Assembler and Linker are under GNU license.
    • The code can be downloaded from Microchip at here.
    • Current MPLAB ASM30 Assembler: v2.04
    • Current MPLAB C30 Compiler: v2.04
  • Important Note: Only the compiler is free. The header files and library are owned by Microchip.
Pic30 C-Compiler Toolchain Templates for Conversion to Debian-based systems
Toolchain Source Instruction Remarks
v2.00 Download pic30-gcc-2.00-1.i386.rpm and pic30-binutils-2.00-1.i386.rpm.
Convert to deb files.
Stable
Now using
v2.05 Reference to example below, but use 2.05 files Can compile
Stable but not heavily tested
v3.01 Follow example below Can compile
Unstable (sometime produce segmentation fault)
v3.10 Reference to example below, but use 3.10 files Cannot compile yet (segmentation fault)

Conversion Example

  • Pre-install these packages: dpkg-dev, debhelper, bison, flex, sysutils, gcc-3.3, fakeroot
    • cmd: sudo apt-get install dpkg-dev debhelper bison flex sysutils gcc-3.3 fakeroot
  • Download and unzip template: pic30-3.01.tar.bz2
  • Download assembler: mplabalc30v3_01_A.tar.gz. Save under /pic30-3.01/pic30-binutils-3.01/upstream/
  • Download c-compiler: mplabc30v3_01_A.tgz. Save under /pic30-3.01/pic30-gcc-3.01/upstream/
  • Install MPLAB_C30_v3_01-StudentEdition under Windows
  • Copy directories /include, /lib, /support, and /bin/c30_device.info to pic30-3.01/pic30-support-3.01/upstream/
  • Pack pic30-binutils into deb file
    • goto /pic30-3.01/pic30-binutils-3.01/
    • type cmd: dpkg-buildpackage -rfakeroot -b
  • Install pic30-binutils_3.01-1_i386.deb
    • type cmd: sudo dpkg -i pic30-binutils_3.01-1_i386.deb
  • Pack pic30-gcc-3.01 into deb file
    • goto /pic30-3.01/pic30-gcc-3.01/
    • type cmd: dpkg-buildpackage -rfakeroot -b
  • Install pic30-gcc_3.01-1_i386.deb
    • type cmd: sudo dpkg -i pic30-gcc_3.01-1_i386.deb
  • Pack support files into deb file
    • goto /pic30-3.01/pic30-support-3.01/
    • type cmd: dpkg-buildpackage -rfakeroot -b
  • Install pic30-support_3.01-1_all.deb
    • type cmd: sudo dpkg -i pic30-support_3.01-1_all.deb
  • After installation, locations of
    • C-Header (*.h): /usr/pic30-elf/include
    • Libraries (*.a): /usr/pic30-elf/lib
    • Assembly header (*.inc): /usr/share/pic30-support/inc
    • Linkerscript (*.gld): /usr/share/pic30-support/gld

Burning Program Codes to Target Board

  1. Use 'dspicprg and dspicdmp' utilities developed by Homer Reid to burn hex code (*.hex) to devices. See Reference here. Through serial port only?
  2. Use Piklab IDE. Details on file format not known.
  3. Use MPLAB IDE to burn hex code (*.hex) to devices.

Code Optimization

  • Below is a comparsion between different optimization levels for the project including drivers for 2 projects.
Comparison between differnt optimization levels
Optimization Description Project 1
Code Size
(byte)
Project 1
Data Usage
(byte)
Project 2
Code Size
(byte)
Project 2
Data Usage
(byte)
O0 No optimization
Fastest Compilation
6222 (9%) 178 (4%) 26,037 (38%) 710 (17%)
O1 Optimize
Tries to reduce code size and execution time.
4473 (6%) 178 (4%) 22,290 (32%) 710 (17%)
O2 Optimize even more
Performs nearly all supported optimizations
that do not involve a space-speed trade-off.
Increases both compilation time and the
performance of the generated code.
4422 (6%) 178 (4%) 21,993 (32%) 710 (17%)
O3 Optimize yet more.
O3 turns on all optimizations specified by O2
and also turns on the inline-functions option.
4485 (6%) 178 (4%) 22,176 (32%) 710 (17%)
Os Optimize for size.
Os enables all O2 optimizations that do not
typically increase code size. It also performs
further optimizations designed to reduce code
size.
4356 (6%) 178 (4%) 21,885 (32%) 710 (17%)


Driver Development

  • Description on developing drivers with POSIX API


Bootloader Development

  • Description on concepts and development on bootloader
  • Description on dsPicProgrammer to download firmware via bootloader


Programming the Device

  • Description on how to use dsPicProgrammer to download firmware to dspic