PIC24 Support Libraries
lib_collection_history.h
1 /*
2  * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
3  * All rights reserved.
4  * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
5  * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
6  * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation for any purpose, without fee, and without written agreement is
10  * hereby granted, provided that the above copyright notice, the following
11  * two paragraphs and the authors appear in all copies of this software.
12  *
13  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
15  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
16  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17  *
18  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
23  *
24  * Please maintain this header in its entirety when copying/modifying
25  * these files.
26  *
27  *
28  */
29 
30 // Documentation placed on the library collection history page. This file only
31 // include comments for Doxygen; it does not contain any
32 // code.
33 /**
34 \page history History and release notes for this library collection.
35 
36 Next release:
37 - No changes yet
38 
39 8-Dec-2017:
40 - Update bootloader to blink the heartbeat LED quickly when the bootloader is waiting.
41 - Ensure the bootloader won't be disabled (a timeout of 0 no longer disables bootloading).
42 
43 1-Dec-2017 (17f5f0196989):
44 - Added bootloader builds for the Microstick II.
45 - Make HARDWARE_PLATFORM more robust to user errors.
46 - Improve clock fail detection and reporting.
47 - Added ESOS UI service.
48 - Added the UNUSED macro to pic24_util.h.
49 - ESOS build fixes.
50 - Clarifed bootloader source file naming.
51 - Cleanup of unnecessary warnings during scons builds.
52 - Additional 40 MHz clocks now supported by the ECAN module.
53 - Use the SCL1/SDA1 pins for dsPIC33EP512GP806, not the ASCL1/ADSDA1 pins by
54  default.
55 - ECAN code fixes based on errata for the dsPIC33EPxxxGP806/810/814.
56 - Documentation cleanup.
57 - Added support for additional chips.
58 - Updated config bits to use new-style \#pragma settings.
59 - Updated linker scripts to v1.30 of xc16.
60 - Use Microchip-defined remappable peripheral info in macros.
61 
62 23-Oct-2015 (6b0cc69cc70a):
63 - Switch to new bootloader based on Qt.
64 - dataXfer protocol updates for the new bootloader.
65 - Docs updated to new Sphinx theme.
66 - Fixes per book errata: see r529 (980397c884fb).
67 - Removed old MPLAB 8 .mcp files (no longer used).
68 - Removed old ASEE and appg files (no longer used).
69 - Removed project files auto-generated by MPLAB X.
70 - Included the PIC bootloader in the documentation.
71 - ECAN code still broken. Comments on a possible fix added.
72 
73 30-Oct-2014 (r525):
74 - Fixes to DMA and ECAN code for E family devices.
75 - Significant rewrite and simplifcation of build system.
76  - Now, individual C files which require a specific peripheral will
77  issue a warning if that peripheral is missing and compile and empty main().
78  - Consistent naming convention establed for esos, bootloader, and library
79  builds.
80 - Significant ESOS additions, including new examples and mailboxes.
81 - Added MicroStik II target platform, Embedded F14 target platform.
82 - Docs cleanup. All examples now hyperlinks to the main examples page.
83 
84 3-Mar-2014 (r476):
85 - Revisions to support the E family devices:
86  - CAN code ported.
87  - UART init code updated.
88  - Assembly code PSV fixes.
89  - SPI supports enhanced buffer mode, runs at 10 MHz.
90  - Timer headers updated.
91 - ADC code made consistent with the textbook.
92 - Bootloader now correctly enables the OSC pins for an external
93  crystal or clock.
94 - FSM example rewrite.
95 - Docs cleanup.
96 
97 4-Nov-2013 (r404 / 3a1ac95477ff):
98 - Fixed ENABLE/DISABLE_Rxy_ANALOG for older (PIC24H) parts.
99 - Eliminated many compiler warnings during a full build.
100 - Fixes to various project files so they'll build.
101 
102 25-Aug-2013 (r385 / e818e78a9810):
103 - Fix to I2C baud rate calcuation (BRG register is 9 bits only).
104 - More projects converted to MPLAB X.
105 - Rewrites to chap 8, 9 files for the book.
106 - Support for deviecs with hardmapped UART pins (28-pin PIC24FK, for example).
107 - Combined pic24_e/fh_ports.h into a single file, added support for PIC24FK
108  analog config.
109 - Doxygen comments added to every GPIO config macro.
110 - New ESOS features: mailboxes and more.
111 - _NOFLOAT actually removes all floats in the library.
112 
113 09-Jul-2013 (r267 / 992b80bc0901):
114 This is a major release / revision in the beta stage. The upcoming book will
115 provide a full description. Just a few highlights:
116 - Update to MPLAB X.
117 - Revised GPIO system.
118 - Updates to code examples for revision of book.
119 - Updated build system.
120 - Refactored bootloader now makes use of the PIC24 library, not a custom
121  cut-and-paste.
122 
123 23-May-2013 (r65 / f5e398dc9af3):
124 - Merge the lib/ subrepo into the main repo.
125 - Clean up Doxygen / compiler warnings.
126 - Updated to AStyle 2.03, ran AStyle.
127 
128 11-Nov-2013 (r61 / 3dfae4d8075a)
129 - Changed function names 'ConfigOutputCapture1' to 'ConfigOutputCompare1' as
130  that is what is really being configured.
131 - Changed ledpwm.c back to reflect what is in the book/notes.
132 - Added ledpwm_bullymon project that demonstrates usage of variable monitoring
133  in Bully Bootloader.
134 - Add: batch files to flash bootloader images
135 - Fixed error in chapter 5 problem 27 solution.
136 
137 24-May-2012 (r55 / 0a577da868fe):
138 - Made warnings in pic24_configbits.c consistent
139 - Made formatting consistent (ran AStyle)
140 - Fixed a few misc compiler warnings
141 
142 22-May-2012 (r50 / 8173e0aa9b43):
143 - Added support for PIC24E/dsPIC33E contained in MPLAB C compiler release 3.31.
144 - Added initial support for PIC24E/dsPIC33E. Most examples tested with
145  24EP64GP202.
146 - Removed stdint.h, since v3.30 of the compiler now has it. For older compilers,
147  put contents of old stdint.h in pic24-generic.h.
148 - Fixed pic24_adc.h to use new-style C99 types (uint16_t, not uint16).
149 
150 5-Mar-2012 (r42 / 7b7f526d7bcc):
151 - Updated .gld and include/devices to support new additions to the PIC24/dsPIC
152  family.
153 
154 2-Mar-2012 (r38 / e76ddf28fbe5):
155 - Removed unnecessary whitespace in pic24_uart.c-template
156 - Made a few strings const, to store them in ROM
157 - Removed scary warning for an unknown revision of a chip
158 - volatile qualifier added to specifyVar
159 - pic24_configbits.c \#warnings reworded to remove unnecessary (and now wrong)
160  file names
161 - New revisions added for two chips
162 - Updated runscons.bat to produce no errors / warnings on a successful compile
163 
164 27-Feb-2012 (r37 / 220dc4d778e9):
165 - Updated chap10/mcp24lc515_i2c_eeprom.c to use BLKSIZE everywhere
166 - Put the link in textbook_examples_dox.h to rtcc.c in the correct area
167 - Fixed bug in outUint8Decimal when x > 100
168 - Fixed to doc to keep Doxygen from complaining; updated ignores, moved to
169  current version of Doxygen.
170 - Changed naming of Microchip include files to capital letters, to build on
171  Linux.
172 - CR/LF -> CR cleanup plus a bit more via AStyle.
173 - SCons build updated to produce Unix-style line endings in the generated
174  template files.
175 - Astyle now runs on the template files
176 - Link to Mercurial repo added on pic24 lib page
177 
178 24-Aug-2011 (r28 / rd3252bde49e7):
179 - Fixed configPinsForLowPower to look at the LPOSCEN / SOSCEN bit to avoid
180  disrupting an attached crystal oscillator.
181 - Moved repo hosting to Bitbucket
182 - Fixed compile errors in ESOS
183 - Update docs generation to include ESOS. Tidyed up doxygen a bit.
184 - lib/common/pic24_stdio_uart.c, chap10/stdio_test.* fixed, updated so
185  it compiles with UART 3, 4
186 - scons build fixes / improvements
187 
188 12-Apr-2011 (r21 / r880971ce93b6):
189 - Simplified the method for selecting which hardware platform
190  to build for by introducing \ref HARDWARE_PLATFORM and
191  appropriately refactoring the code.
192 - Added support for the The Microchip 16-bit 28-pin Starter Board,
193  Part number DM300027. Thanks to Istvan for contributing this!
194  See \ref STARTER_BOARD_28P.
195 - Merged in support for the Dangerous Prototypes web platform.
196  See \ref DANGEROUS_WEB.
197 - Updated the build process to build reset for all supported platforms.
198 - Updated doxygen to not include files from lib/includes/devices.
199 - Updated runastyle.bat; now uses Unix line endings.
200 - Cleaned up comments in pic24_libconfig.h.
201 - Ran astyle, moving the files to unix-style line ends.
202 - Added this history file.
203 
204 Previous to this, history resided in SVN. Sigh.
205 */