Difference between revisions of "DsPIC30F 5011 Development Board"

Revision as of 18:53, 22 November 2006

Introduction

Features of dsPIC30F5011

2.5 to 5V
Up to 30MIPs
High current/sink source I/O pins: 25mA
DSP Instruction Set
Dual programming techniques: ICSP and RTSP
UART: up to 2 modules
I²C: up to 1Mbps
10-bit A/D, 1.1 Msps
12-bit A/D, 500 ksps
66Kb flash, 4Kb RAM, 1Kb EEPROM
No DAC

Web Page

Microchip Official Website

Forum

Microchip: Official forum by Microchip
- MPLAB ICD 2: Subforum on ICD 2 programmer
- MPLAB IDE: Subforum on IDE
- MPLAB C30 Compiler, ASM30, Link30 forum: Subforum on C compiler. Refer to MPLAB C30 C Compiler User's Guide Chapter 3
- dsPIC30F Topics: Subformum on dsPIC30F

GNUPIC: Discussion on PIC in Linux Systems
- Debian

HI-TECH Software Forum: Discussion on dsPICC, a C compiler developed by HI-TECH

PICList: Discussion on older PIC systems (not dsPIC)

PicKit: Discussion on PICkit/PICkit 2 programmers

References

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

Two types of ICSP are available: ICSP and Enhanced ICSP. Both of them require setting ^MCLR to V_IHH (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.
- Refer to Section 11 for programming in ICSP.
- Program memory can be erased using Normal-Voltage (4.5 – 5.5V) or Low-Voltage (2.5V – 4.5V).

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.
- Refer to Section 8 for programming the PE.

Hardware Interface

Table 2.1 Pin Used by ICSP
Pin Label	Function	Pin Number
^MCLR	Programming Enable	7
V_DD	Power Supply	10, 26, 38, 57
V_SS	Ground	9, 25, 41, 56
PGC	Serial Clock	17
PGD	Serial Data	18

Table 2.2 Available Programmers in the Market
Product Name	Interface with PC	Interface with Device	Price (US)	Postage (US)	Total (US)
MPLAB^® ICD 2	USB/RS232	6-PIN RJ-12 connector	$159.99	-	-
PRESTO PIC Programmer Plus	USB	?	$200.16	$15.00	$215.16
Full Speed USB Microchip ICD2 Debugger and Programmer	USB	6-PIN ICSP connector 6-PIN RJ-12 connector	$72.00	$12.00	$84.00
Mini Microchip Compatible ICD2 Debugger and Programmer	RS232	6-PIN ICSP connector 6-PIN RJ-12 connector	$45.00	$10.00	$55.00
ICDX30	RS232	6-pin RJ-11	$51.00	$47.46	$98.46
Clone Microchip ICD2	RS232	6-pin flat cables	$30.00	$12.00	$42.00

Table 2.3 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.

Table 2.4 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 version¹)
Piklab 0.12.0	Assembler and C-Compiler	Linux	Free²

Full-featured for the first 60 days. After 60 days only optimization level 1 can be enabled in the compiler. 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

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

Circuit Design and PCB

IC Requirements

Table 3.1 IC Requirements
Part No.	Description	Min Temp	Max Temp	Min Volt	Max Volt	Typ Cur	Max Cur
dsPIC30F5011-30I/PT	uP	-40^oC	85^oC	2.5V ^[1]	5.5V		250mA
MAX3232ESE	RS232 driver	-40^oC	85^oC	3.0V	5.5V	0.3mA	1.0mA
ADM483E ANZ	RS485 driver	-40^oC	85^oC	4.5V	5.5V	0.036mA
DAC6574DGS	10-bit Quad-DAC I²C	-40^oC	105^oC	2.7V	5.5V	0.6mA	0.9mA
74HC14D	Quad-Schmitt Trigger	-40^oC	125^oC	2.0V	6.0V		50mA
Overall		-40^oC	85^oC	4.5V	5.5V		<310mA ^[2]

Minimum voltage measured is 3.3V (with 2 LEDs blinking) running at 30MHz.
Measured current at 5V is 180mA (with 2 LEDs blinking only)

Module Board

Functions
- Primary communication with other module boards via RS232 over short distance.
- Secondary communication with benchtop via RS458 over longer distance.
- Digital control I/O for 1 laser (e.g. on/off, detect temp overheat, current alarm)
- Analog input for data acquisation on power, current and temperature
- Analog output for power and current control

Table 3.2 Module
Digital Input	Digital Output	Analog Input	Analog Output
1. ICSP	1. LED 2. Bi-color LED 3. RS232 4. RS458 5. Case temp overheat 6. Laser on/off 1,2 7. Interlock 8. Digital ctrl 9. Current 0,1 alarm	1. Case temp 2. pow 0,1 3. cur0 4. temp0	1. 10-bit DAC

Benchtop

Functions
- Primary communciation with module boards via RS485
- Secondary communication with other benchtops via RS232
- Digital I/O control for 2 lasers
- Analog inputs on power, current and temperature
- Analog outputs for power and current control
- LCD display and rotary key for user input

Table 3.3 Base Benchtop
Digital Input	Digital Output	Analog Input	Analog Output
1. ICSP 2. Rotary Key 3. Push Buttons	1. LED 2. RS232 3. RS458 4.LCD display 5. Buzzer 6. Digital Ctrl 0,1	1. Case temp 2. CurrentDetect 0,1 3. PowerDetect 0,1,2,3 4. TempDetect	1. 10-bit DAC (PowerCurrentCtrl 0,1)

Development Environment

Windows

C-Compiler, Assembler and Linker are under GNU license.
- MPLAB C30 C Compiler (*.c -> *.s)
- MPLAB ASM30 Assembler (*.s -> *.o)
- MPLAB LINK30 Linker (*.o -> *.exe)

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. Refer to Table 3.4.

C-libraries contained in C30 includes (Refer to 16-Bit Language Tools Libraries from Microchip).

Table 5.1 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 (e.g. libp30F5011-coff.a)	\lib \src\peripheral \support\h	ADC12, IOPort, UART, I²C, 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

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

John Steele Scott has made templates that can be readily used by Debian-based systems. Someone at http://noel.feld.cvut.cz/dspic/ has done the necessary conversion to *.deb already.
- Download pic30-1.32-debian.tar.bz2 for Template v1.32. (For v2.01, please goto pic30-debian-2.01.tar.bz2).
- Download pic30-binutils_1.32-1_i386.deb for the assember.
- Download pic30-gcc_1.32-1_i386.deb for the compiler.

Important Note: Only the compiler is free. The header files and library is owned by Microchip.
- 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 here.
- Instructions for filling the upstream direction is available here.
- Alteratively, Stephan Walter has started a project to develop C Runtime Library for dsPIC.
  - 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

Burning Program Codes to Target Board

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

Programming Tips

Memory Map for 5011

+-------------------------------------+ 0x000000 to 0x00AFFE
|..............Flash.................|
|.........(22K x16 bits)..........|
+-------------------------------------+ 0x00B000 to 0x7FFBFE
|............Reserved..............|
+-------------------------------------+ 0x7FFC00 to 0x7FFFFE
|.............EEPROM............|
|...........(1K x 8 bits)..........|
+-------------------------------------+ 0x800000 to 0x8005BE
|................PE..................|
+-------------------------------------+ 0x8005C0 to 0x8005FE
|..............Unit ID...............|
+-------------------------------------+ 0x800600 to 0xF7FFFE
|............Reserved..............|
+-------------------------------------+ 0xF80000 to 0xF8000E
|........Config Registers.......|
+-------------------------------------+ 0xF80010 to 0xFEFFFE
|............Reserved..............|
+-------------------------------------+ 0xFF0000 to 0xFF0002
|..............Device ID...........|_______________________0x0080
+-------------------------------------+ 0xFF0002 to 0xFF0004
|............Reserved..............|
+-------------------------------------+ 0xFFFFFE

Data Location

Table 7.1 Data Location
Type	Description	Example
_XBSS(N) ^[1]	RAM Data in X-memory, aligned at N, no initilization	int _XBSS(32) xbuf[16];
_XDATA(N) ^[1]	RAM Data in X-memory, aligned at N, with initilization	int _XDATA(32) xbuf[] = {1, 2, 3, 4, 5};
_YBSS(N) ^[1]	RAM Data in Y-memory, aligned at N, no initilization	int _YBSS(32) ybuf[16];
_YDATA(N) ^[1]	RAM Data in Y-memory, aligned at N, with initilization	int _YDATA(32) ybuf[16] = {1, 2, 3, 4, 5};
__attribute__((space(const)))	Flash ROM data, constant, accessed by normal C statements, but 32K max.	int i __attribute__((space(const))) = 10;
__attribute__((space(prog)))	Flash ROM data, read/write by program space visibility window (psv)	int i __attribute__((space(prog)));
__attribute__((space(auto_psv)))	Flash ROM data, read by normal C statements, write by accessing psv	int i __attribute__((space(auto_psv)));
__attribute__((space(psv)))	Flash ROM data, read/write by (psv)	int i __attribute__((space(psv)));
_EEDATA(N) ^[1]	ROM Data in EEPROM, aligned at N, read/write with psv	int _EEDATA(2) table[]={0, 1, 1, 2, 3, 5, 8}; void main(){ PSVPAG = __builtin_psvpage(&table); CORCONbits.PSV = 1; ... if(table[2]){ ... } }
_PERSISTENT	RAM Data, data remain after reset	int _PERSISTENT var1, var2;
_NEAR	RAM Data at near section	int _NEAR var1, var2;
_ISR	Interrupt service rountine	void _ISR _INT0Interrupt(void);
_ISRFAST	Fast interrupt service rountine	void _ISRFAST _T0Interrupt(void);

N must be a power of two, with a minimum value of 2.

Driver Development

Table 7.2 Driver Development
Item	Description	Start Date	Completion Date	Test Date
DI/DO and 10ms Timer interrupt	Simple switching of LEDs	07 Nov 2006	08 Nov 2006	15 Nov 2006
UART	RS232 and RS485	08 Nov 2006	10 Nov 2006	16 Nov 2006
I²C	DAC	13 Nov 2006	13 Nov 2006	Pending
Analog I/O	Sampling analog signal
Usage of Standard C-libraries	1. math.h 2. stdlib.h	08 Nov 2006	08 Nov 2006	21 Nov 2006
Usage of DSP libraries	1. Vector 2. Matrix 3. DFT
Usage of Buildin libraries	1. __builtin_add 2. __builtin_divud 3. __builtin_clr

Bootloader

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.

Table 8.1 Free bootloaders for dsPIC
Developer	Source	Platform	User Guide	Remarks
ingenia	Assembly	Windows	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
Tiny	Assembly	Windows	Web	By default, only supports 601X, 601X, 401X, 2010 Smaller code size than ingenia, but not as easy to modify
Elektronika	Hex	Windows	txt	Only works for dsPIC30F6014 serial port UART2 at baudrate 57600

ingenia

Modification

Changes made to 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

Communication Protocol

Communication Protocol is reviewed in user's guide section 2.1.3. The following summarises the key steps on the PC side (Refer also to section 2.2.2).
Transmission is conducted in 8N1, i.e. 8-bit, no parity, 1 stop-bit
Stage 1: User's configuation
- Select a baudrate
- Select a COM port channel
Stage 2: Autobaud rate detection and version control
- Continuously sending a character "U" [0x55] via COM port
- Continuously waiting for an acknowledgment character "U", [ACK] = [0x55]
- Send command character [0x03]
- Receive 3 characters 1) Major Version 2) Minor Version 3) Acknowledgment [0x33]
- Prints the version number [Major.Minor] (e.g. 1.1) on screen.
Stage 3: Loading and writing the program
- Load the user hex file, check integrity.
- Start loading file using:
  - Read command character [0x01] + 24-bit address [High][Medium][Low]
  - Receive 4-byte data [High][Medium][Low][ACK]
  - 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)
  - Recieve [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)

Ensure the initial address of writing match an initial row position,
Send the data corresponding to the whole row.

Procedures for Mass Production

Requirements

Hardware

PC with COM port (Windows XP Installed)
ICD2 Programmer
Target Board
5V Power Supply

Software

Files

Modified ingenia bootloader (ingenia.hex). Original assembly code can be downloaded from here.
Application hex file (e.g. app.hex)

Procedures

Loading Bootloader

Install MPLAB IDE on PC

Do NOT connect ICD 2 (via USB) to PC
Execute MPLAB vX.XX Install.exe

Install USB Driver for ICD 2

Follow the instruction in (C:\Program Files\Microchip\MPLAB IDE\ICD2\Drivers\Ddicd2.htm)

Run MPLAB IDE on PC
Plug-in ICD 2 to PC (USB)

Do NOT connect target (via 6-pin cable) to ICD 2

Select ICD 2 as the current programmer

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
You should also see Warnings on invalid device IDs, and/or running self tests. Ignore these warnings since the target board has not been connected yet.

Place Jumper on target board
Connect target board to ICD 2 (via six pin cable)

Beware of the pin assignments. Only pin 1 - 5 should be used.

Power-up the Target
Establish connection with target

On MPLAB IDE, Select Programmer>Connect
See results of self test: Programmer>Settings, Status Tab. Refer to ICD2 User's Guide Chapter 7.

Load the bootloader hex file ingenia.hex on MPLAB IDE

Select: File>Import...

Download the bootloader to target board

Select: Programmer>Program

Power-down the Taget.
Disconnect ICD 2 from PC

Select: Programmer>Select Programmer>None
Unplug USB cable

Loading Application

Install ingenia dsPIC bootloader GUI on PC

Execute ingeniadsPICbootloader.exe

Connect target board to COM Port
Power-down target board
Run ingenia dsPIC bootloader GUI
Press "OK, my platform is shut down" in Dialog 0
Select COM port and baud rate in Dialog 1
Power-up target board in Dialog 2
Load the app.hex by pressing Open in Dialog 3
Download the hex file by pressing Write in Dialog 3
Power-down target board and disconnect from COM port

@@ Line 190: / Line 190: @@
 *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 bootloader section.
 ==Circuit Design and PCB==
@@ Line 195: / Line 196: @@
 ===IC Requirements===
 {|border="1" cellspacing="0" cellpadding="5"
-|+ Table 4.1 IC Requirements
+|+ Table 3.1 IC Requirements
 ! Part No. !! Description
 ! Min Temp !! Max Temp !! Min Volt !! Max Volt !! Typ Cur !! Max Cur
@@ Line 242: / Line 243: @@
 {|border="1" cellspacing="0" cellpadding="5"
-|+ Table 4.2 Module
+|+ Table 3.2 Module
 ! Digital Input !! Digital Output !! Analog Input !! Analog Output
 |-valign="top"
@@ Line 262: / Line 263: @@
 {|border="1" cellspacing="0" cellpadding="5"
-|+ Table 4.3 Base Benchtop
+|+ Table 3.3 Base Benchtop
 ! Digital Input !! Digital Output !! Analog Input !! Analog Output
 |-valign="top"