PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 - Switch to new bootloader based on Qt.
38 - dataXfer protocol updates for the new bootloader.
39 - Docs updated to new Sphinx theme.
40 - Fixes per book errata: see r529 (980397c884fb).
41 - Removed old MPLAB 8 .mcp files (no longer used).
42 - Removed old ASEE and appg files (no longer used).
43 - Removed project files auto-generated by MPLAB X.
44 - Included the PIC bootloader in the documentation.
45 - ECAN code still broken. Comments on a possible fix added.
46 
47 30-Oct-2014 (r525):
48 - Fixes to DMA and ECAN code for E family devices.
49 - Significant rewrite and simplifcation of build system.
50  - Now, individual C files which require a specific peripheral will
51  issue a warning if that peripheral is missing and compile and empty main().
52  - Consistent naming convention establed for esos, bootloader, and library
53  builds.
54 - Significant ESOS additions, including new examples and mailboxes.
55 - Added MicroStik II target platform, Embedded F14 target platform.
56 - Docs cleanup. All examples now hyperlinks to the main examples page.
57 
58 3-Mar-2014 (r476):
59 - Revisions to support the E family devices:
60  - CAN code ported.
61  - UART init code updated.
62  - Assembly code PSV fixes.
63  - SPI supports enhanced buffer mode, runs at 10 MHz.
64  - Timer headers updated.
65 - ADC code made consistent with the textbook.
66 - Bootloader now correctly enables the OSC pins for an external
67  crystal or clock.
68 - FSM example rewrite.
69 - Docs cleanup.
70 
71 4-Nov-2013 (r404 / 3a1ac95477ff):
72 - Fixed ENABLE/DISABLE_Rxy_ANALOG for older (PIC24H) parts.
73 - Eliminated many compiler warnings during a full build.
74 - Fixes to various project files so they'll build.
75 
76 25-Aug-2013 (r385 / e818e78a9810):
77 - Fix to I2C baud rate calcuation (BRG register is 9 bits only).
78 - More projects converted to MPLAB X.
79 - Rewrites to chap 8, 9 files for the book.
80 - Support for deviecs with hardmapped UART pins (28-pin PIC24FK, for example).
81 - Combined pic24_e/fh_ports.h into a single file, added support for PIC24FK
82  analog config.
83 - Doxygen comments added to every GPIO config macro.
84 - New ESOS features: mailboxes and more.
85 - _NOFLOAT actually removes all floats in the library.
86 
87 09-Jul-2013 (r267 / 992b80bc0901):
88 This is a major release / revision in the beta stage. The upcoming book will
89 provide a full description. Just a few highlights:
90 - Update to MPLAB X.
91 - Revised GPIO system.
92 - Updates to code examples for revision of book.
93 - Updated build system.
94 - Refactored bootloader now makes use of the PIC24 library, not a custom
95  cut-and-paste.
96 
97 23-May-2013 (r65 / f5e398dc9af3):
98 - Merge the lib/ subrepo into the main repo.
99 - Clean up Doxygen / compiler warnings.
100 - Updated to AStyle 2.03, ran AStyle.
101 
102 11-Nov-2013 (r61 / 3dfae4d8075a)
103 - Changed function names 'ConfigOutputCapture1' to 'ConfigOutputCompare1' as
104  that is what is really being configured.
105 - Changed ledpwm.c back to reflect what is in the book/notes.
106 - Added ledpwm_bullymon project that demonstrates usage of variable monitoring
107  in Bully Bootloader.
108 - Add: batch files to flash bootloader images
109 - Fixed error in chapter 5 problem 27 solution.
110 
111 24-May-2012 (r55 / 0a577da868fe):
112 - Made warnings in pic24_configbits.c consistent
113 - Made formatting consistent (ran AStyle)
114 - Fixed a few misc compiler warnings
115 
116 22-May-2012 (r50 / 8173e0aa9b43):
117 - Added support for PIC24E/dsPIC33E contained in MPLAB C compiler release 3.31.
118 - Added initial support for PIC24E/dsPIC33E. Most examples tested with
119  24EP64GP202.
120 - Removed stdint.h, since v3.30 of the compiler now has it. For older compilers,
121  put contents of old stdint.h in pic24-generic.h.
122 - Fixed pic24_adc.h to use new-style C99 types (uint16_t, not uint16).
123 
124 5-Mar-2012 (r42 / 7b7f526d7bcc):
125 - Updated .gld and include/devices to support new additions to the PIC24/dsPIC
126  family.
127 
128 2-Mar-2012 (r38 / e76ddf28fbe5):
129 - Removed unnecessary whitespace in pic24_uart.c-template
130 - Made a few strings const, to store them in ROM
131 - Removed scary warning for an unknown revision of a chip
132 - volatile qualifier added to specifyVar
133 - pic24_configbits.c \#warnings reworded to remove unnecessary (and now wrong)
134  file names
135 - New revisions added for two chips
136 - Updated runscons.bat to produce no errors / warnings on a successful compile
137 
138 27-Feb-2012 (r37 / 220dc4d778e9):
139 - Updated chap10/mcp24lc515_i2c_eeprom.c to use BLKSIZE everywhere
140 - Put the link in textbook_examples_dox.h to rtcc.c in the correct area
141 - Fixed bug in outUint8Decimal when x > 100
142 - Fixed to doc to keep Doxygen from complaining; updated ignores, moved to
143  current version of Doxygen.
144 - Changed naming of Microchip include files to capital letters, to build on
145  Linux.
146 - CR/LF -> CR cleanup plus a bit more via AStyle.
147 - SCons build updated to produce Unix-style line endings in the generated
148  template files.
149 - Astyle now runs on the template files
150 - Link to Mercurial repo added on pic24 lib page
151 
152 24-Aug-2011 (r28 / rd3252bde49e7):
153 - Fixed configPinsForLowPower to look at the LPOSCEN / SOSCEN bit to avoid
154  disrupting an attached crystal oscillator.
155 - Moved repo hosting to Bitbucket
156 - Fixed compile errors in ESOS
157 - Update docs generation to include ESOS. Tidyed up doxygen a bit.
158 - lib/common/pic24_stdio_uart.c, chap10/stdio_test.* fixed, updated so
159  it compiles with UART 3, 4
160 - scons build fixes / improvements
161 
162 12-Apr-2011 (r21 / r880971ce93b6):
163 - Simplified the method for selecting which hardware platform
164  to build for by introducing \ref HARDWARE_PLATFORM and
165  appropriately refactoring the code.
166 - Added support for the The Microchip 16-bit 28-pin Starter Board,
167  Part number DM300027. Thanks to Istvan for contributing this!
168  See \ref STARTER_BOARD_28P.
169 - Merged in support for the Dangerous Prototypes web platform.
170  See \ref DANGEROUS_WEB.
171 - Updated the build process to build reset for all supported platforms.
172 - Updated doxygen to not include files from lib/includes/devices.
173 - Updated runastyle.bat; now uses Unix line endings.
174 - Cleaned up comments in pic24_libconfig.h.
175 - Ran astyle, moving the files to unix-style line ends.
176 - Added this history file.
177 
178 Previous to this, history resided in SVN / HG. Sigh.
179 */