common/pic24_util.c

Go to the documentation of this file.

/*
 * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
 * All rights reserved.
 * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
 * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
 * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
 *
 * Permission to use, copy, modify, and distribute this software and its
 * documentation for any purpose, without fee, and without written agreement is
 * hereby granted, provided that the above copyright notice, the following
 * two paragraphs and the authors appear in all copies of this software.
 *
 * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
 * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
 * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
 *
 * Please maintain this header in its entirety when copying/modifying
 * these files.
 *
 *
 */



// Documentation for this file. If the \file tag isn't present,
// this file won't be documented.
#include "pic24_all.h"
#include <stdio.h>        // To define NULL


#if !USE_HEARTBEAT
//empty functions
void configHeartbeat(void) {
}
void doHeartbeat(void) {
}

void toggleHeartbeat(void) {
}
#else

uint32 u32_heartbeatCount;
uint32 u32_heartbeatMax;


void configHeartbeat(void) {
  CONFIG_HB_LED();
  /* long enough to see LED toggle. Incrementing the heartbeat
  takes several cycles - CYCLES_PER_MS used as the multiplier so that
  we are tied to FCY
  */
  u32_heartbeatMax = CYCLES_PER_MS * 10;
  u32_heartbeatCount = 0;
  HB_LED = 0;   // Turn LED off to show we started running
  doHeartbeat();    // do Heartbeat   at least once
}

void doHeartbeat(void) {
  u32_heartbeatCount++;
  if (u32_heartbeatCount > u32_heartbeatMax) {
    toggleHeartbeat();
    u32_heartbeatCount = 0;
  }
}

//simply toggles the Heartbeat LED
void toggleHeartbeat(void) {
  HB_LED = !HB_LED;
}

#endif

_PERSISTENT const char* sz_lastError;
_PERSISTENT char* sz_lastTimeoutError;

#ifndef __PIC24F__

_PERSISTENT INTTREGBITS INTTREGBITS_last;
#define u16_INTTREGlast BITS2WORD(INTTREGBITS_last)
#else
uint16 u16_INTTREGlast;
#endif

void _ISR _DefaultInterrupt(void) {
#ifndef __PIC24F__
  // Record the interrupt vector and priority of the
  // unhandled interrupt.
  u16_INTTREGlast = INTTREG;
#else
  // Any non-zero value causes reportError to report
  // this. This register doesn't exist on the PIC24F.
  u16_INTTREGlast = 1;
#endif
  reportError("Unhandled interrupt, ");
}


void reportError(const char* sz_errorMessage) {
  //ignore if a previous error has already been triggerred
  if (sz_lastError == NULL) {
    sz_lastError = sz_errorMessage;
    asm ("reset");
  }
}

uint32 readProgramMemory(uint32 address) {
  uint16 offset = address;
  TBLPAG = address >> 16;
  return ( ((uint32) __builtin_tblrdh(offset)) << 16) |
         __builtin_tblrdl(offset);
}

void checkDeviceAndRevision(void) {
#ifdef SIM
  outString("**** SIMULATION MODE: cannot read device and revision ID ****\n");
#else
  uint32 devID = readProgramMemory(DEV_ID_LOCATION);
  uint32 revision = readProgramMemory(REVISION_LOCATION);
  uint8 correctChip = 1;
  char* devIDStr = "unknown";
  char* revisionStr = "unknown";

  if (devID == DEV_ID)
    devIDStr = DEV_ID_STR;
  else
    correctChip = 0;

  switch (revision) {
    case EXPECTED_REVISION1 :
      revisionStr = EXPECTED_REVISION1_STR;
      break;
#ifdef EXPECTED_REVISION2
    case EXPECTED_REVISION2 :
      revisionStr = EXPECTED_REVISION2_STR;
      break;
#endif
#ifdef EXPECTED_REVISION3
    case EXPECTED_REVISION3 :
      revisionStr = EXPECTED_REVISION3_STR;
      break;
#endif
#ifdef EXPECTED_REVISION4
    case EXPECTED_REVISION4 :
      revisionStr = EXPECTED_REVISION4_STR;
      break;
#endif
#ifdef EXPECTED_REVISION5
    case EXPECTED_REVISION5 :
      revisionStr = EXPECTED_REVISION5_STR;
      break;
#endif
    default :
      correctChip = 0;
      break;
  }

  outString("Device ID = ");
  outUint32(devID);
  outString(" (");
  outString(devIDStr);
  outString("), revision ");
  outUint32(revision);
  outString(" (");
  outString(revisionStr);
  outString(")\n");

  if (!correctChip)
    outString("\n\n"
              "*****************************************************\n"
              "* WARNING - this program was compiled for the wrong *\n"
              "* chip or for an unknown revision of this chip!     *\n"
              "* This program may produce unexpected behvior! Edit *\n"
              "* the header files to properly define this chip or  *\n"
              "* revision and to insure correct operation.         *\n"
              "*                                                   *\n"
              "* NOTE: If this was compiled for the correct chip,  *\n"
              "* and only occurs at power-on (not during a MCLR    *\n"
              "* reset, verify that AVDD and AVSS are connected.   *\n"
              "* On the PIC24H32GP202, not connecting AVDD         *\n"
              "* produces this message only at power-up.           *\n"
              "*****************************************************\n");
#endif
}

void checkOscOption(void) {
  uint8 u8_x;

  u8_x = _COSC;         // Get current oscillator setting
  switch (u8_x) {
    case 0:
      outString("Fast RC Osc\n");
      break;
    case 1:
      outString("Fast RC Osc with PLL\n");
      break;
    case 2:
      outString("Primary Osc (XT, HS, EC)\n");
      break;
    case 3:
      outString("Primary Osc (XT, HS, EC) with PLL\n");
      break;
    case 4:
      outString("Secondary Osc\n");
      break;
    case 5:
      outString("Low Power RC Osc\n");
      break;
#if defined(__PIC24H__)
    case 6:
      outString("Fast RC Osc/16\n");
      break;
    case 7:
      outString("Fast RC Osc/N\n");
      break;
#elif defined(__PIC24F__)
    case 7 :
      outString("Fast RC Osc with Postscale");
      break;
#else
#error Unknown processor
#endif
    default :
      reportError("Unknown oscillator type.");
      break;
  }
}

void printResetCause(void) {
  uint8 u8_resetIdentified;

  u8_resetIdentified = 0;
  if (_SLEEP) {
    outString("\nDevice has been in sleep mode\n");
    _SLEEP = 0;
  }
  if (_IDLE) {
    outString("\nDevice has been in idle mode\n");
    _IDLE = 0;
  }
  outString("\nReset cause: ");
  if (_POR) {
    u8_resetIdentified = 1;
    outString("Power-on.\n");
    _POR = 0;
    _BOR = 0; //clear both
    // Set the values below, which reset all the
    // error reporting variables to indicate that
    // no error has (yet) occurred.
    sz_lastError = NULL;
    sz_lastTimeoutError = NULL;
    u16_INTTREGlast = 0;
  } else {
    //non-POR
    if (_SWR) {
      outString("Software Reset.\n");
      u8_resetIdentified = 1;
      _SWR = 0;
      _EXTR = 0;  //also sets the EXTR bit
    }
    if (_WDTO) {
      u8_resetIdentified = 1;
      outString("Watchdog Timeout: ");
      if (sz_lastTimeoutError != NULL) {
        outString(sz_lastTimeoutError);
      }
      outString("\n");
      _WDTO = 0;
      _EXTR = 0; //also sets the EXTR bit
    }
    if (_EXTR) {
      u8_resetIdentified = 1;
      outString("MCLR assertion.\n");
      _EXTR = 0;
    }
    if (_BOR) {
      u8_resetIdentified = 1;
      outString("Brown-out.\n");
      _BOR = 0;
    }
    if (_TRAPR) {
      u8_resetIdentified = 1;
      outString("Trap Conflict.\n");
      _TRAPR = 0;
    }
    if (_IOPUWR) {
      u8_resetIdentified = 1;
      outString("Illegal Condition.\n");
      _IOPUWR = 0;
    }
#ifdef _CM
    if (_CM) {
      u8_resetIdentified = 1;
      outString("Configuration Mismatch.\n");
      _CM = 0;
    }
#endif
  } //end non-POR

  if (!u8_resetIdentified) {
    outString("Unknown reset.\n");
  }
  if (sz_lastError != NULL) {
    outString("Error trapped: ");
    outString(sz_lastError);
    if (u16_INTTREGlast != 0) {
#ifndef __PIC24F__
      outString("Priority: ");
      outUint8(INTTREGBITS_last.ILR);
      outString(", Vector number: ");
      outUint8(INTTREGBITS_last.VECNUM);
#else
      outString("Unknown priority/vector");
#endif
    }
    outString("\n\n");
    sz_lastError = NULL;
    u16_INTTREGlast = 0;
  }

  checkDeviceAndRevision();
  checkOscOption();
}

//this function is processor specific
#if (defined(__PIC24HJ32GP202__) || \
   defined(__PIC24FJ64GA002__))
void configPinsForLowPower(void) {
  // Configure all digital I/O pins for input
  TRISB = 0xFFFF;
  TRISA = 0xFFFF;
  // Configure all analog pins as digital I/O
#if defined(__PIC24F__)
  AD1PCFG = 0xFFFF;
#elif defined(__PIC24H__)
  AD1PCFGL = 0xFFFF;
#else
#error Unknown processor
#endif
  // Enable all pullups, except those which clocks are
  // connected to.

  // CN31-CN16 enable, based on if primary osc is used
  // or not.
#if (FNOSC_SEL == FNOSC_PRI) || (FNOSC_SEL == FNOSC_PRIPLL)
#if (POSCMD_SEL == POSCMD_EC)
  // The external oscillator driving the clock is on OSCI,
  // which is CN30. Don't enable the pullup on this pin to
  // avoid interfering with it.
  // Note that CNPU2 covers CN31 to CN16.
  CNPU2 = 0xBFFF;
#else
  // The crystal driving the primary oscillator is on OSCI/OSCO,
  // which is CN30 and CN29. Don't enable pullups on these pins,
  // since that will prevent the crystal from oscillating.
  // Note that CNPU2 covers CN31 to CN16.
  CNPU2 = 0x9FFF;
#endif // #if (POSCMD_SEL == POSCMD_EC)
#else // The primary oscillator is not selected
  // Turn on all the pull-ups
  CNPU2 = 0xFFFF;
#endif

  // CN15-CN0 enable, based on if secondary osc is used
  // or not.
#if (FNOSC_SEL == FNOSC_SOSC)
  // The crystal driving the secondary oscillator is on
  // SOSCI/SOSCO, which is CN1 and CN0.
  CNPU1 = 0xFFFC;
#else
  CNPU1 = 0xFFFF;
#endif
}
#else
#warning Using dummy function for configPinsForLowPower() in 'common/pic24_util.c'
void configPinsForLowPower(void) {
}
#endif


void configBasic(const char* sz_helloMsg) {
  configHeartbeat();
  configClock();
  configDefaultUART(DEFAULT_BAUDRATE);
  printResetCause();
  outString(sz_helloMsg);
}

---