|
PIC24 Support Libraries
|
Go to the source code of this file.
Macros | |
| #define | REPORT_ERROR(msg) reportError(ERROR_FILE_LINE(msg)) |
Bitfield to struct conversion | |
Given a bitfield struct representing an SFR, convert this to a word (uint16_t) or to the high and low bytes (uint8_t) of that word. Note: though this looks ugly, it introduces no unexpected compiler overhead at -O1. See u16_INTTREGlast for an example. | |
| #define | BITS2WORD(sfrBitfield) ( *((uint16_t*) &sfrBitfield) ) |
| Convert a bitfield to a word (uint16_t). | |
| #define | BITS2BYTEL(sfrBitfield) ( ((uint8_t*) &sfrBitfield)[0] ) |
| Return the low byte (as a uint8_t) of a bitfield. | |
| #define | BITS2BYTEH(sfrBitfield) ( ((uint8_t*) &sfrBitfield)[1] ) |
| Return the high byte (as a uint8_t) of a bitfield. | |
Functions | |
| void | reportError (const char *szErrorMessage) |
| uint32_t | readProgramMemory (uint32_t u32_address) |
| void | checkDeviceAndRevision (void) |
| void | checkOscOption (void) |
| void | printResetCause (void) |
| void | configPinsForLowPower (void) |
| void | configBasic (const char *psz_helloMsg) |
| uint32_t | roundFloatToUint32 (float f_x) |
| uint16_t | roundFloatToUint16 (float f_x) |
| void | configHeartbeat (void) |
| void | doHeartbeat (void) |
| void | toggleHeartbeat (void) |
Variables | |
| _PERSISTENT const char * | sz_lastTimeoutError |
| uint32_t | u32_heartbeatCount |
This file contains miscellaneous functions that that do not fall under any particular category. See pic24_util.c for details on how these functions were implemented.
Definition in file pic24_util.h.
| #define REPORT_ERROR | ( | msg) | reportError(ERROR_FILE_LINE(msg)) |
Report an error on reset via reportError, also printing the file and line number where this macro was called via a call to ERROR_FILE_LINE.
| msg | Error message to report |
Definition at line 69 of file pic24_util.h.
Referenced by configDefaultUART(), inChar(), isCharReady(), and outChar().
| void checkDeviceAndRevision | ( | void | ) |
Determines the device and revision of the PIC this program is executing on. This information is then output via the default UART. A warning message is issued if this program was not compiled for the chip it is running on.
Definition at line 195 of file pic24_util.c.
Referenced by printResetCause().
| void checkOscOption | ( | void | ) |
Reports the oscillator currently in use to the default serial port.
Definition at line 266 of file pic24_util.c.
Referenced by printResetCause().
| void configBasic | ( | const char * | sz_helloMsg) |
Perform basic chip configuration:
| sz_helloMsg | Hello message to print. |
Definition at line 501 of file pic24_util.c.
Referenced by main().
| void configHeartbeat | ( | void | ) |
Configures a GPIO pin for use with the heartbeat and sets up the heartbeat counter.
Definition at line 81 of file pic24_util.c.
Referenced by configBasic(), and main().
| void configPinsForLowPower | ( | void | ) |
This function puts the PIC24 in low-power mode by:
WARNING: if pullups are enabled on pins used by the oscillator, the clock typically stops running. Currently, this code works for demo purposes with the FRC oscillator when used in the reset.c program. It should also work with primary and secondary oscillators, using conditional compiles in the code.
Definition at line 487 of file pic24_util.c.
Referenced by main().
| void doHeartbeat | ( | void | ) |
This heartbeat function should be called repeatedly in any sort of blocking wait loop. It will periodically toggle an LED after u32_heartbeatMax increments.
Definition at line 97 of file pic24_util.c.
Referenced by configHeartbeat(), doErasePageFlash(), doWriteRowFlash(), inChar1(), ioMasterSPI1(), main(), outChar1(), WAIT_UNTIL_CONVERSION_COMPLETE_ADC1(), and WAIT_UNTIL_TRANSMIT_COMPLETE_UART1().
| void printResetCause | ( | void | ) |
Determines and prints the cause of a CPU reset. This should be called when the chip first starts up. For an example, see the configBasic function.
Definition at line 313 of file pic24_util.c.
Referenced by configBasic(), and main().
Reads a 24-bit program memory word at the given address.
| u32_address | Address of program memory to read. |
Definition at line 183 of file pic24_util.c.
Referenced by checkDeviceAndRevision().
| void reportError | ( | const char * | sz_errorMessage) |
Report a critical error by recording a message in sz_lastError then resetting the chip, assuming hat printResetCause will be called during chip initialization.
| sz_errorMessage | Error message to report. |
Definition at line 170 of file pic24_util.c.
Referenced by _DefaultInterrupt(), checkOscOption(), checkRxErrorUART1(), picAssert(), and putI2C1().
| uint16_t roundFloatToUint16 | ( | float | f_x) |
Round a floating-point number to the nearest integer.
| f_x | Floating-point value to round |
Definition at line 526 of file pic24_util.c.
Referenced by configUART1(), msToU16Ticks(), and usToU16Ticks().
| uint32_t roundFloatToUint32 | ( | float | f_x) |
Round a floating-point number to the nearest integer.
| f_x | Floating-point value to round |
Definition at line 514 of file pic24_util.c.
Referenced by ticksToMs(), ticksToNs(), ticksToUs(), and usToU32Ticks().
| void toggleHeartbeat | ( | void | ) |
A function which toggles the hearbeat LED.
Definition at line 109 of file pic24_util.c.
Referenced by doHeartbeat().
| _PERSISTENT const char* sz_lastTimeoutError |
Persistent storage for a timeout error, to be reported if a watchdog reset occurs.
Definition at line 123 of file pic24_util.c.
Referenced by convertADC1(), getI2C1(), printResetCause(), putI2C1(), putNoAckCheckI2C1(), rstartI2C1(), startI2C1(), and stopI2C1().
| uint32_t u32_heartbeatCount |
The current heartbeat count. When this value reaches u32_heartbeatMax, the heatbeat LED is toggled by doHeartbeat().
Definition at line 70 of file pic24_util.c.
Referenced by configHeartbeat(), delayAndUpdateHeartbeatCount(), and doHeartbeat().
1.8.4