Trevor's Electonics Blog

This fix refers to the library version release 12 April 2011. When using an Explorer 16 board and setting the Macro definition of EXPLORER16_100P in MPLab, parts of the library do not pick it up correctly rendering the heartbeat LED and the UART to not work. No compilor error is noticed.

In the file lib\include\pic24_libconfig.h at line 76, change the following section of code:

/** Select one of the hardware platform above to compile for. */
#ifndef HARDWARE_PLATFORM
#define HARDWARE_PLATFORM DEFAULT_DESIGN
#endif
// Verify that a valid hardware platform is selectd
#if (HARDWARE_PLATFORM != EXPLORER16_100P)   && \
    (HARDWARE_PLATFORM != DANGEROUS_WEB)     && \
    (HARDWARE_PLATFORM != STARTER_BOARD_28P) && \
    (HARDWARE_PLATFORM != DEFAULT_DESIGN)
#error Invalid hardware platform selected.
#endif
//@}

Replacing the above code with this code:

/** Select one of the hardware platform above to compile for. */
/* The automated method expects the board is defined in MPLAB
   using Use Project->Build Options-> Project, click on
   the MPLAB C30 tab, and in Macro Definitions click 'Add',
   and add:
      - For the Explorer 16 board - EXPLORER16_100P
      - For the Dangerous Prototypes web server - DANGEROUS_WEB
      - For the Microchip 16-bit 28-pin Starter Board - STARTER_BOARD_28P
   If the above is not set, the code will compile with the default
   of DEFAULT_DESIGN
*/
#ifndef HARDWARE_PLATFORM
#ifdef EXPLORER16_100P
#define HARDWARE_PLATFORM EXPLORER16_100P
#elif STARTER_BOARD_28P
#define HARDWARE_PLATFORM STARTER_BOARD_28P
#elif DANGEROUS_WEB
#define HARDWARE_PLATFORM DANGEROUS_WEB
#else
#define HARDWARE_PLATFORM DEFAULT_DESIGN
#endif
#endif
// Verify that a valid hardware platform is selectd
#if (HARDWARE_PLATFORM != EXPLORER16_100P)   && \
    (HARDWARE_PLATFORM != DANGEROUS_WEB)     && \
    (HARDWARE_PLATFORM != STARTER_BOARD_28P) && \
    (HARDWARE_PLATFORM != DEFAULT_DESIGN)
#error Invalid hardware platform selected.
#endif
//@}

This will now pick up the Macro definition set in MPLab and compile the components of the library needed for the Explorer 16 to function.

So far have tested the above with the Explorer 16, PIC24HJ256GP610A PIM, and the reset.c example from chapter 8 in the Microcontrollers: From Assembly Language to C Using the PIC24 Family.

For those that use the Explorer 16 board and have in the last 12 or so months purchased the PIC24HJ256GP610 PIM from Microchip (part number MA240012) may have noticed it’s got a different chip on it. It now uses the PIC24HJ256GP610A which has some issues when using the library included with the book Microcontrollers: From Assembly Language to C Using the PIC24 Family.

This article shows how I modified the library (12 Apr 2011 version) from http://www.ece.msstate.edu/courses/ece3724/main_pic24/labs/files/pic24_code_examples.zip

In lib\common\pic24_configbits.c at about line 261 fine the line that contains

#if defined(EXPLORER16_100P) && defined(__PIC24HJ256GP610__)

and change it to

#if defined(EXPLORER16_100P) && (defined(__PIC24HJ256GP610__) || defined(__PIC24HJ256GP610A__))

In lib\include\pic24_ports.h at about line 700 you will find the following:

00700 #elif defined(__PIC24HJ256GP610__)
00701
00702 #include "devices/pic24hj256gp610_ports.h"

Change line 700 to:

#elif defined((__PIC24HJ256GP610__) || defined(__PIC24HJ256GP610A__))

The above uses the same .h file for the 610A as for the 610 on the assumption the two are pin compatible in every way. I have not yet found they are not, or any other reason to use a seperate ports file for the chip.

In lib\include\pic24_chip.h at aprox line 336 you will find the following little block of code:

#ifdef __PIC24HJ256GP610__
#define DEV_ID 0x00007B
#define DEV_ID_STR "PIC24HJ256GP610"
#endif

#if (defined(__PIC24HJ64GP206__) || defined(__PIC24HJ64GP210__) || defined(__PIC24HJ64GP506__)
|| defined(__PIC24HJ64GP510__)\
|| defined(__PIC24HJ128GP206__) || defined(__PIC24HJ128GP210__) || defined(__PIC24HJ128GP306__)\
|| defined(__PIC24HJ128GP310__) || defined(__PIC24HJ128GP506__)|| defined(__PIC24HJ128GP510__)\
|| defined(__PIC24HJ256GP206__) || defined(__PIC24HJ256GP210__)|| defined(__PIC24HJ256GP610__))

#define EXPECTED_REVISION1 0x003002
#define EXPECTED_REVISION1_STR "A2"
#define EXPECTED_REVISION2 0x003004
#define EXPECTED_REVISION2_STR "A3"
#define EXPECTED_REVISION3 0x003040
#define EXPECTED_REVISION3_STR "A4"
#endif

Replace this block of code above with:

#ifdef __PIC24HJ256GP610__
#define DEV_ID 0x00007B
#define DEV_ID_STR "PIC24HJ256GP610"
#endif

#ifdef __PIC24HJ256GP610A__
#define DEV_ID 0x0000077B
#define DEV_ID_STR "PIC24HJ256GP610A"
#endif

#if (defined(__PIC24HJ64GP206__) || defined(__PIC24HJ64GP210__) || defined(__PIC24HJ64GP506__)\
|| defined(__PIC24HJ64GP510__)\
|| defined(__PIC24HJ128GP206__) || defined(__PIC24HJ128GP210__) || defined(__PIC24HJ128GP306__)\
|| defined(__PIC24HJ128GP310__) || defined(__PIC24HJ128GP506__)|| defined(__PIC24HJ128GP510__)\
|| defined(__PIC24HJ256GP206__) || defined(__PIC24HJ256GP210__)|| defined(__PIC24HJ256GP610__))
#define EXPECTED_REVISION1 0x003002
#define EXPECTED_REVISION1_STR "A2"
#define EXPECTED_REVISION2 0x003004
#define EXPECTED_REVISION2_STR "A3"
#define EXPECTED_REVISION3 0x003040
#define EXPECTED_REVISION3_STR "A4"
#endif

#if defined(__PIC24HJ256GP610A__)
#define EXPECTED_REVISION1 0x003003
#define EXPECTED_REVISION1_STR "A1"
#endif

I’m not sure what the second last line #define EXPECTED_REVISION1_STR “A1″ should be and have not been able to find it, but the above has been tested using the reset.c example from chapter 8 of the book on the Explorer 16 and is working (provided you have also performed the mod described in this article).

This will update the library to accommodate for the new version of the PIC24HJ256GP610 PIM which now uses a PIC24HJ256GP610A.

Hi again. Onto the next example, this time on page 295 (figure 8.28). The code for this one is called ‘ledtoggle_nofsm’ and it’s in the chap8 folder.

Now that we’ve defined EXPLORER16_100P in the pic24_all.h file, here is a new checklist to use:

1. Double click on the project file for the exercise your wanting to do. (Make sure you don’t already have MPLAB open or it will complain)
2. Set the processor type in the menu item Configure – Select Device. The default PIC24 that comes with the Explorer16 is PIC24FJ128GA010.
3. Remove the linker script from the workspace files viewer under “Linker Scripts” (don’t add anything, MPLAB will manage it for you)
4. Change from DEBUG to RELEASE in the drop down at top of MPLAB screen
5. Select your programmer (Programmer – Select Programmer). I use the ICD2
6. Make required changes to the code (see below for this exercise)
7. CTRL-F10 to build all
8. When you get the BUILD SUCCEDED message, program the chip (Programmer – Program)
9. Click ok the the ICDWarn0046 warning (unless you’ve got sick of this message and clicked the “don’t show me again” like I did)
10. disconnect the ICD2 when the programmer has completed.

Here is the modification needed for this one to work. Shown here is the code between the #include directive and the start of the main() function.

You should see the very left LED blinking. When you press the right of the 4 buttons, the second from left LED should toggle (light up if it’s the first press). Keep pressing and releasing and observe what happens. You will notice the LED state doesn’t change until the button is released.

#include "pic24_all.h"

/** \file
A program that toggles an LED whenever a pushbutton switch is pressed
and released. Does not use a finite statement approach.
*/

#if defined(EXPLORER16_100P)

/// LED1
#define CONFIG_LED1() CONFIG_RA6_AS_DIG_OUTPUT()
#define LED1  _LATA6    //_LATA6 is port register for RA6
#warning Were using the explorer16 version of the code
/// Switch1 configuration
inline void CONFIG_SW1()  {
  CONFIG_RD13_AS_DIG_INPUT();     //use RD13 for switch input
  ENABLE_RD13_PULLUP();           //enable the pullup 
}
#define SW1              _RD13       //switch state

#else  // not Explorer16

/// LED1
#define CONFIG_LED1() CONFIG_RB14_AS_DIG_OUTPUT()
#define LED1  _LATB14     //led1 state
#warning If your using an Explorer16, this program wont work
/// Switch1 configuration
inline void CONFIG_SW1()  {
  CONFIG_RB13_AS_DIG_INPUT();     //use RB13 for switch input
  ENABLE_RB13_PULLUP();           //enable the pullup 
}
#define SW1              _RB13       //switch state

#endif  // if defined EXPLORER16_100P

#define SW1_PRESSED()   SW1==0  //switch test
#define SW1_RELEASED()  SW1==1  //switch test

int main (void) {
.....

Example 7 which is Figure 8.30 on page 298 is called ledtoggle and is in the chap8 folder. It’s the same changes as example 6 above except the original code has some extra bits that example 6 didn’t have.

#include "pic24_all.h"

/** \file
A program that uses a finite state machine approach for
toggling an LED whenever a pushbutton switch is pressed
and released. Demonstrates the use of debounce delays when
polling a switch input.
*/

#if defined(EXPLORER16_100P)

/// LED1
#define CONFIG_LED1() CONFIG_RA6_AS_DIG_OUTPUT()
#define LED1  _LATA6    //_LATA6 is port register for RA6
#warning Were using the explorer16 version of the code

/// Switch1 configuration
inline void CONFIG_SW1()  {
  CONFIG_RD13_AS_DIG_INPUT();     //use RD13 for switch input
  ENABLE_RD13_PULLUP();           //enable the pullup
}
#define SW1              _RD13       //switch state

#else  // not Explorer16

/// LED1
#define CONFIG_LED1() CONFIG_RB14_AS_DIG_OUTPUT()
#define LED1  _LATB14     //led1 state
#warning If your using an Explorer16, this program wont work

/// Switch1 configuration
inline void CONFIG_SW1()  {
  CONFIG_RB13_AS_DIG_INPUT();     //use RB13 for switch input
  ENABLE_RB13_PULLUP();           //enable the pullup
}
#define SW1              _RB13       //switch state

#endif  // if defined EXPLORER16_100P

#define SW1_PRESSED()   SW1==0  //switch test
#define SW1_RELEASED()  SW1==1  //switch test

typedef enum  {
.....

I enjoyed this example as it’s interfacing between the user and the MCU via a computer. It also showed some interesting concepts on power management within source code.

I did notice this time I needed to use a different approach to telling the compiler I’m using the Explorer16. For some reason, it would not maintain the setting using the preprogrammer directive. So open up the file include\pic24_all.h and right at the start of the code, add the directive

#define EXPLORER16_100P

Here is the snippit of the file.
 

// Documentation for this file. If the \file tag isn't present,
// this file won't be documented.
/** \file
 *  This header file includes the all the pic24_*.h files as detailed
 *  in the \ref index and also includes the necessary
 *  processor-specific include file (via a \#include p24h/fxxxx.h).
 */
// Added this define as I'm using the Explorer16 for these examples.
#define EXPLORER16_100P
#ifndef _PIC24_ALL_H_
#define _PIC24_ALL_H_

// Include processor-specific header file
#if defined(__PIC24H__)

You will also need to change the device to your processor as the default project uses the PIC24HJ32GP202. It should be PIC24FJ128GP010 if your using the default PIM on the Explorer 16. You do this in the menu item [Configure] – [Select Device].

The UART example on page 262 just needs the Explorer16 check list from the last article to make it work and the ASM example I skipped as it’s not needed at this stage of my journey.

The file name for the Figure 8.6 example is documented in the book. Well done to the author and publisher It’s called ‘echo’ for those that might have missed it.

Continuing with Chapter 8, the next file is the one referred to in Figure 8:5 Improved code example for flashing LED. It takes the previous one and modifies it using macro’s. Well we sort of used macros in the last one to break out the Explorer 16 version and the original. This file is called “ledflash” and it’s also in the chapter 8 folder.

You will see what the author had in mind. The use of macro’s certainly makes it easier to see what is going on. Here is the modified code that enables the Explorer 16 to run this. Don’t forget to define EXPLORER16_100P.

#if defined(EXPLORER16_100P)
#define CONFIG_LED1() CONFIG_RA6_AS_DIG_OUTPUT()
#define LED1 _LATA6 //_LATA6 is port register for RA6
#warning Were using the explorer16
#else // not Explorer16
#define CONFIG_LED1() CONFIG_RB15_AS_DIG_OD_OUTPUT()
#define LED1 _LATB15 //_LATB15 is port register for RB15
#warning Were not using the explorer16 because EXPLORER16_100P not defined
#endif // if defined EXPLORER16_100P

int main(void) {

  configClock();
  /********** GPIO config **********/
  CONFIG_LED1();
  LED1 = 0;
  while (1) {
    DELAY_MS(250); //delay long enough to see LED blink
    LED1 = !LED1; // Toggle LED
  } // end while (1)
}

This time all the configuration changes needed are done in the short macro section while leaving the actual code identical effectively creating a hardware abstraction layer between the code and the hardware.

Ok so now time to build. Here is a check list to follow for these examples.

1. Define EXPLORER16_100P (Project – Build Options – Project. Then the MPLAB C30 tab. Add the preprocessor macro.
2. Remove the linker script from the workspace files viewer under “Linker Scripts” (dont add anything, MPLAB will manage it for you)
3. Change from DEBUG to RELEASE in the drop down at top of MPLAB screen
4. Select your programmer (Programmer – Select Programmer). I use the ICD2
5. CTRL-F10 to build all
6. When you get the BUILD SUCCEDED message, program the chip (Programmer – Program)
7. Click ok the the ICDWarn0046 warning
8. disconnect the ICD2 when the programmer has completed.

You should now see the LED connected to RA6 (second from left) flash at about 1 per second.

One thing I do want to point out, I am not going to teach you about programming and the PIC etc. The intent of this blog is share my adventures and if you happen to learn something from that, well that’s good. The other thing I’m going to recommend is to buy the book referred to here. See the books web site here. This is also the web site where you will find all the original code the book discusses and what I refer to here.

Well I’m going to run with the PIC24 for the time being and use the Microcontrollers – From Assembly Language to C Using the PIC24 Family book, but jumping to chapter 8 as the assembly language is not what I want at the moment. It’s learning about C and the PIC24. Anyway, as I’m using the Explorer 16 board, I’m going to share the differences in the sample code that should apply. This is the first installment for chapter 8.

My first observation is the author hasn’t identified the file names of the examples in his book and as his book doesn’t include the full text of the samples, it’s a bit of guess work to find them. So I’ll help you along your way. The first example on page 258 is called “ledflash_nomacros” and it’s in the chap8 folder.

One thing you need to do with all the examples when using the Explorer16 board is define the macro EXPLORER16_100P either in the include/pic24_all.h file or it must be added to the MPLAB project (Use Project->Build Options-> Project, click on the MPLAB C30 tab, and in Macro Definitions click ‘Add’, and add EXPLORER16_100P). Where it makes sense, I’m going to use the macro definition to keep the original code in tact while adding specific changes for the Explorer 16 board.

Note: the PIM I’m using is the PIC24FJ128GA010 100pin PIM (Microchip part number MA240011).

So here is the source for main() for this exercise. The rest of the file should remain the same.

void a_delay(void) {
  uint16 u16_i,u16_k;
  // change count values to alter delay
  for (u16_k=1800; --u16_k;) {
    for (u16_i = 1200 ; --u16_i ; );
  }
}
int main(void) {
  configClock();    //clock configuration
  /********** GPIO config **********/

#if defined(EXPLORER16_100P)

// For the explorer 16, we're not going to use the open drain as the LED is
// wired from ground through a current limit resistor direct to pin 91 of
// the PIC24FJ128GA010

  _TRISA6 = 0;         //Config RB15 as output
  _LATA6 = 0;          //RB15 initially low
  while (1) {           //infinite while loop
    a_delay();          //call delay function
    _LATA6 = !_LATA6;  //Toggle LED attached to RB15
  } // end while (1)
#warning using Explorer16 code

#else // not EXPLORER16_100P

#ifdef _ODB15          //PIC24F CPU header files define this instead of ODCB15
  _ODB15 = 1;          //enable open drain
#else
  _ODCB15 = 1;          //enable open drain
#endif
  _TRISB15 = 0;         //Config RB15 as output
  _LATB15 = 0;          //RB15 initially low
  while (1) {           //infinite while loop
    a_delay();          //call delay function
    _LATB15 = !_LATB15;  //Toggle LED attached to RB15
  } // end while (1)
#warning NOT using Explorer16 code

#endif  //#if defined(EXPLORER16_100P)

}

When you open the project file (.mcp) for this exercise you will notice the linker script in the linker scripts section of the files explorer. You need to delete this one. No need to add another one as MPLAB will pick up the right one automatically if you have used the default install.

You will notice in this code segment I’ve added a couple of warning messages for the compiler to see what parts of the code it compiles. You can have them in or take them out. They are there just to make sure the compiler is doing what is expected.

Now if you try and use DEBUG as per the default project, you will see a number of failures and the program wont run. The first will be a pop up message:

• ICDWarn0046:  Because clock switching is enabled, MPLAB ICD 2 requires the user to cycle target power after a program operation.

And then a message in the output window:

• ICD0083: Debug:  Unable to enter debug mode.  Please double click this message for more information.

I chose to ignore and change to a RELEASE build to see it working. Do this by following these steps:

1. Change the DEBUG drop down to RELEASE
2. Select a programmer (Programmer – Select Programmer). I’m using the MPLAB ICD2 so the rest talks about what happens with the ICD2.
3. Rebuild all (Ctrl+F10)
4. When you get the BUILD SUCCEEDED message, program the device (Programmer – Program). You will get the ICDWarn0046 message, just click OK.
5. When you get the “MPLAB ICD 2 ready for next operation”, disconnect the ICD2 and watch your program run. The LED second from left will flash at about once per second.